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 dnac_log_file_path, dnac_log_append common intent documentation file #137

Merged
merged 4 commits into from
Feb 4, 2024
Merged
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
40 changes: 33 additions & 7 deletions plugins/doc_fragments/intent_params.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,16 +50,42 @@ class ModuleDocFragment(object):
default: false
dnac_log:
description:
- Flag for logging playbook execution details.
If set to true the log file will be created at the location of the execution with the name dnac.log
- Flag for logging playbook execution details.
If set to true the log file will be created at the location of the execution with the name dnac.log
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to change this.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CAn you please take care in your next Commit?

type: bool
default: false
dnac_log_level:
description:
- Specifies the desired log level for Cisco Catalyst Center logging.
Options - [CRITICAL, ERROR, WARNING, INFO, DEBUG]
type: str
default: WARNING
description:
- Sets the threshold for log level. Messages with a level equal to or higher than
this will be logged. Levels are listed in order of severity [CRITICAL, ERROR, WARNING, INFO, DEBUG].
- CRITICAL Indicates serious errors halting the program. Displays only CRITICAL messages.
- ERROR Indicates problems preventing a function. Displays ERROR and CRITICAL messages.
- WARNING Indicates potential future issues. Displays WARNING, ERROR, CRITICAL messages.
- INFO Tracks normal operation. Displays INFO, WARNING, ERROR, CRITICAL messages.
- DEBUG Provides detailed diagnostic info. Displays all log messages.
type: str
default: WARNING
dnac_log_file_path:
description:
- Governs logging. Logs are recorded if dnac_log is True.
- If path is not specified,
- 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 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
validate_response_schema:
description:
- Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.
Expand Down
Loading