Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added the documentation part for dnac_log_file_path, dnac_log_append, Added the missing type in import documentation for template_intent module #135

Merged
merged 1 commit into from
Feb 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions plugins/modules/device_credential_intent.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,27 @@
author: Muthu Rakesh (@MUTHU-RAKESH-27)
Madhan Sankaranarayanan (@madhansansel)
options:
dnac_log_file_path:
description:
- Governs logging. Logs are recorded if dnac_log is True.
- If unspecified,
- When 'dnac_log_append' is True, 'dnac.log' is generated in the
current Ansible directory; logs are appended.
- When 'dnac_log_append' is False, 'dnac.log' is generated; logs
are overwritten.
- If a path is specified,
- When 'dnac_log_append' is True, the file opens in append mode.
- When 'dnac_log_append' is False, the file opens in write (w) mode.
- In shared file scenarios, without append mode, content is
overwritten after each module execution.
- For a shared log file, set append to False for the 1st module
(to overwrite); for subsequent modules, set append to True.
type: str
default: dnac.log
dnac_log_append:
description: Determines the mode of the file. Set to True for 'append' mode. Set to False for 'write' mode.
type: bool
default: True
config_verify:
description: Set to True to verify the Cisco DNA Center after applying the playbook config.
type: bool
Expand Down Expand Up @@ -2568,6 +2589,8 @@ def main():
"dnac_debug": {"type": 'bool', "default": False},
"dnac_log": {"type": 'bool', "default": False},
"dnac_log_level": {"type": 'str', "default": 'WARNING'},
"dnac_log_file_path": {"type": 'str', "default": 'dnac.log'},
"dnac_log_append": {"type": 'bool', "default": True},
"config_verify": {"type": 'bool', "default": False},
"config": {"type": 'list', "required": True, "elements": 'dict'},
"state": {"default": 'merged', "choices": ['merged', 'deleted']},
Expand Down
23 changes: 23 additions & 0 deletions plugins/modules/discovery_intent.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,27 @@
author: Abinash Mishra (@abimishr)
Phan Nguyen (phannguy)
options:
dnac_log_file_path:
description:
- Governs logging. Logs are recorded if dnac_log is True.
- If unspecified,
- When 'dnac_log_append' is True, 'dnac.log' is generated in the
current Ansible directory; logs are appended.
- When 'dnac_log_append' is False, 'dnac.log' is generated; logs
are overwritten.
- If a path is specified,
- When 'dnac_log_append' is True, the file opens in append mode.
- When 'dnac_log_append' is False, the file opens in write (w) mode.
- In shared file scenarios, without append mode, content is
overwritten after each module execution.
- For a shared log file, set append to False for the 1st module
(to overwrite); for subsequent modules, set append to True.
type: str
default: dnac.log
dnac_log_append:
description: Determines the mode of the file. Set to True for 'append' mode. Set to False for 'write' mode.
type: bool
default: True
config_verify:
description: Set to True to verify the Cisco DNA Center config after applying the playbook config.
type: bool
Expand Down Expand Up @@ -997,6 +1018,8 @@ def main():
'dnac_debug': {'type': 'bool', 'default': False},
'dnac_log': {'type': 'bool', 'default': False},
'dnac_log_level': {'type': 'str', 'default': 'WARNING'},
"dnac_log_file_path": {"type": 'str', "default": 'dnac.log'},
"dnac_log_append": {"type": 'bool', "default": True},
'validate_response_schema': {'type': 'bool', 'default': True},
'config_verify': {"type": 'bool', "default": False},
'config': {'required': True, 'type': 'list', 'elements': 'dict'},
Expand Down
23 changes: 23 additions & 0 deletions plugins/modules/inventory_intent.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,27 @@
author: Abhishek Maheshwari (@abmahesh)
Madhan Sankaranarayanan (@madhansansel)
options:
dnac_log_file_path:
description:
- Governs logging. Logs are recorded if dnac_log is True.
- If unspecified,
- When 'dnac_log_append' is True, 'dnac.log' is generated in the
current Ansible directory; logs are appended.
- When 'dnac_log_append' is False, 'dnac.log' is generated; logs
are overwritten.
- If a path is specified,
- When 'dnac_log_append' is True, the file opens in append mode.
- When 'dnac_log_append' is False, the file opens in write (w) mode.
- In shared file scenarios, without append mode, content is
overwritten after each module execution.
- For a shared log file, set append to False for the 1st module
(to overwrite); for subsequent modules, set append to True.
type: str
default: dnac.log
dnac_log_append:
description: Determines the mode of the file. Set to True for 'append' mode. Set to False for 'write' mode.
type: bool
default: True
config_verify:
description: Set to True to verify the Cisco Catalyst Center config after applying the playbook config.
type: bool
Expand Down Expand Up @@ -3217,6 +3238,8 @@ def main():
'dnac_version': {'type': 'str', 'default': '2.2.3.3'},
'dnac_debug': {'type': 'bool', 'default': False},
'dnac_log_level': {'type': 'str', 'default': 'WARNING'},
"dnac_log_file_path": {"type": 'str', "default": 'dnac.log'},
"dnac_log_append": {"type": 'bool', "default": True},
'dnac_log': {'type': 'bool', 'default': False},
'validate_response_schema': {'type': 'bool', 'default': True},
'config_verify': {'type': 'bool', "default": False},
Expand Down
23 changes: 23 additions & 0 deletions plugins/modules/pnp_intent.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,27 @@
Rishita Chowdhary (@rishitachowdhary)
Abinash Mishra (@abimishr)
options:
dnac_log_file_path:
description:
- Governs logging. Logs are recorded if dnac_log is True.
- If unspecified,
- When 'dnac_log_append' is True, 'dnac.log' is generated in the
current Ansible directory; logs are appended.
- When 'dnac_log_append' is False, 'dnac.log' is generated; logs
are overwritten.
- If a path is specified,
- When 'dnac_log_append' is True, the file opens in append mode.
- When 'dnac_log_append' is False, the file opens in write (w) mode.
- In shared file scenarios, without append mode, content is
overwritten after each module execution.
- For a shared log file, set append to False for the 1st module
(to overwrite); for subsequent modules, set append to True.
type: str
default: dnac.log
dnac_log_append:
description: Determines the mode of the file. Set to True for 'append' mode. Set to False for 'write' mode.
type: bool
default: True
config_verify:
description: Set to True to verify the Cisco DNA Center config after applying the playbook config.
type: bool
Expand Down Expand Up @@ -1106,6 +1127,8 @@ def main():
'dnac_debug': {'type': 'bool', 'default': False},
'dnac_log': {'type': 'bool', 'default': False},
'dnac_log_level': {'type': 'str', 'default': 'WARNING'},
"dnac_log_file_path": {"type": 'str', "default": 'dnac.log'},
"dnac_log_append": {"type": 'bool', "default": True},
'validate_response_schema': {'type': 'bool', 'default': True},
'config_verify': {"type": 'bool', "default": False},
'config': {'required': True, 'type': 'list', 'elements': 'dict'},
Expand Down
23 changes: 23 additions & 0 deletions plugins/modules/provision_intent.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,27 @@
- cisco.dnac.intent_params
author: Abinash Mishra (@abimishr)
options:
dnac_log_file_path:
description:
- Governs logging. Logs are recorded if dnac_log is True.
- If unspecified,
- When 'dnac_log_append' is True, 'dnac.log' is generated in the
current Ansible directory; logs are appended.
- When 'dnac_log_append' is False, 'dnac.log' is generated; logs
are overwritten.
- If a path is specified,
- When 'dnac_log_append' is True, the file opens in append mode.
- When 'dnac_log_append' is False, the file opens in write (w) mode.
- In shared file scenarios, without append mode, content is
overwritten after each module execution.
- For a shared log file, set append to False for the 1st module
(to overwrite); for subsequent modules, set append to True.
type: str
default: dnac.log
dnac_log_append:
description: Determines the mode of the file. Set to True for 'append' mode. Set to False for 'write' mode.
type: bool
default: True
config_verify:
description: Set to True to verify the Cisco Catalyst Center config after applying the playbook config.
type: bool
Expand Down Expand Up @@ -587,6 +608,8 @@ def main():
'dnac_debug': {'type': 'bool', 'default': False},
'dnac_log': {'type': 'bool', 'default': False},
"dnac_log_level": {"type": 'str', "default": 'WARNING'},
"dnac_log_file_path": {"type": 'str', "default": 'dnac.log'},
"dnac_log_append": {"type": 'bool', "default": True},
"config_verify": {"type": 'bool', "default": False},
'validate_response_schema': {'type': 'bool', 'default': True},
'config': {'required': True, 'type': 'list', 'elements': 'dict'},
Expand Down
23 changes: 23 additions & 0 deletions plugins/modules/site_intent.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,27 @@
Rishita Chowdhary (@rishitachowdhary)
Abhishek Maheshwari (@abhishekmaheshwari)
options:
dnac_log_file_path:
description:
- Governs logging. Logs are recorded if dnac_log is True.
- If unspecified,
- When 'dnac_log_append' is True, 'dnac.log' is generated in the
current Ansible directory; logs are appended.
- When 'dnac_log_append' is False, 'dnac.log' is generated; logs
are overwritten.
- If a path is specified,
- When 'dnac_log_append' is True, the file opens in append mode.
- When 'dnac_log_append' is False, the file opens in write (w) mode.
- In shared file scenarios, without append mode, content is
overwritten after each module execution.
- For a shared log file, set append to False for the 1st module
(to overwrite); for subsequent modules, set append to True.
type: str
default: dnac.log
dnac_log_append:
description: Determines the mode of the file. Set to True for 'append' mode. Set to False for 'write' mode.
type: bool
default: True
config_verify:
description: Set to True to verify the Cisco Catalyst Center config after applying the playbook config.
type: bool
Expand Down Expand Up @@ -1026,6 +1047,8 @@ def main():
'dnac_version': {'type': 'str', 'default': '2.2.3.3'},
'dnac_debug': {'type': 'bool', 'default': False},
'dnac_log_level': {'type': 'str', 'default': 'WARNING'},
"dnac_log_file_path": {"type": 'str', "default": 'dnac.log'},
"dnac_log_append": {"type": 'bool', "default": True},
'dnac_log': {'type': 'bool', 'default': False},
'validate_response_schema': {'type': 'bool', 'default': True},
'config_verify': {'type': 'bool', "default": False},
Expand Down
23 changes: 23 additions & 0 deletions plugins/modules/swim_intent.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,27 @@
Rishita Chowdhary (@rishitachowdhary)
Abhishek Maheshwari (@abmahesh)
options:
dnac_log_file_path:
description:
- Governs logging. Logs are recorded if dnac_log is True.
- If unspecified,
- When 'dnac_log_append' is True, 'dnac.log' is generated in the
current Ansible directory; logs are appended.
- When 'dnac_log_append' is False, 'dnac.log' is generated; logs
are overwritten.
- If a path is specified,
- When 'dnac_log_append' is True, the file opens in append mode.
- When 'dnac_log_append' is False, the file opens in write (w) mode.
- In shared file scenarios, without append mode, content is
overwritten after each module execution.
- For a shared log file, set append to False for the 1st module
(to overwrite); for subsequent modules, set append to True.
type: str
default: dnac.log
dnac_log_append:
description: Determines the mode of the file. Set to True for 'append' mode. Set to False for 'write' mode.
type: bool
default: True
config_verify:
description: Set to True to verify the Cisco Catalyst Center config after applying the playbook config.
type: bool
Expand Down Expand Up @@ -1631,6 +1652,8 @@ def main():
'dnac_version': {'type': 'str', 'default': '2.2.3.3'},
'dnac_debug': {'type': 'bool', 'default': False},
'dnac_log_level': {'type': 'str', 'default': 'WARNING'},
"dnac_log_file_path": {"type": 'str', "default": 'dnac.log'},
"dnac_log_append": {"type": 'bool', "default": True},
'dnac_log': {'type': 'bool', 'default': False},
'validate_response_schema': {'type': 'bool', 'default': True},
'config_verify': {'type': 'bool', "default": False},
Expand Down
25 changes: 24 additions & 1 deletion plugins/modules/template_intent.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,27 @@
Akash Bhaskaran (@akabhask)
Muthu Rakesh (@MUTHU-RAKESH-27)
options:
dnac_log_file_path:
description:
- Governs logging. Logs are recorded if dnac_log is True.
- If unspecified,
- When 'dnac_log_append' is True, 'dnac.log' is generated in the
current Ansible directory; logs are appended.
- When 'dnac_log_append' is False, 'dnac.log' is generated; logs
are overwritten.
- If a path is specified,
- When 'dnac_log_append' is True, the file opens in append mode.
- When 'dnac_log_append' is False, the file opens in write (w) mode.
- In shared file scenarios, without append mode, content is
overwritten after each module execution.
- For a shared log file, set append to False for the 1st module
(to overwrite); for subsequent modules, set append to True.
type: str
default: dnac.log
dnac_log_append:
description: Determines the mode of the file. Set to True for 'append' mode. Set to False for 'write' mode.
type: bool
default: True
config_verify:
description: Set to True to verify the Cisco DNA Center after applying the playbook config.
type: bool
Expand Down Expand Up @@ -579,7 +600,7 @@
type: str
import:
description: Import the project/template details.
type:
type: dict
suboptions:
project:
description: Import the project details.
Expand Down Expand Up @@ -2762,6 +2783,8 @@ def main():
'dnac_debug': {'type': 'bool', 'default': False},
'dnac_log': {'type': 'bool', 'default': False},
"dnac_log_level": {"type": 'str', "default": 'WARNING'},
"dnac_log_file_path": {"type": 'str', "default": 'dnac.log'},
"dnac_log_append": {"type": 'bool', "default": True},
'validate_response_schema': {'type': 'bool', 'default': True},
"config_verify": {"type": 'bool', "default": False},
'config': {'required': True, 'type': 'list', 'elements': 'dict'},
Expand Down
Loading