summaryrefslogtreecommitdiffstats
path: root/ansible_collections/cisco/dnac/plugins/doc_fragments
diff options
context:
space:
mode:
Diffstat (limited to 'ansible_collections/cisco/dnac/plugins/doc_fragments')
-rw-r--r--ansible_collections/cisco/dnac/plugins/doc_fragments/intent_params.py54
-rw-r--r--ansible_collections/cisco/dnac/plugins/doc_fragments/workflow_manager_params.py117
2 files changed, 169 insertions, 2 deletions
diff --git a/ansible_collections/cisco/dnac/plugins/doc_fragments/intent_params.py b/ansible_collections/cisco/dnac/plugins/doc_fragments/intent_params.py
index fe95d684d..7e61fedc8 100644
--- a/ansible_collections/cisco/dnac/plugins/doc_fragments/intent_params.py
+++ b/ansible_collections/cisco/dnac/plugins/doc_fragments/intent_params.py
@@ -50,10 +50,60 @@ options:
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 to enable/disable playbook execution logging.
+ - When true and dnac_log_file_path is provided,
+ - Create the log file at the execution location with the specified name.
+ - When true and dnac_log_file_path is not provided,
+ - Create the log file at the execution location with the name 'dnac.log'.
+ - When false,
+ - Logging is disabled.
+ - If the log file doesn't exist,
+ - It is created in append or write mode based on the "dnac_log_append" flag.
+ - If the log file exists,
+ - It is overwritten or appended based on the "dnac_log_append" flag.
type: bool
default: false
+ dnac_log_level:
+ 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
+ dnac_api_task_timeout:
+ description: Defines the timeout in seconds for API calls to retrieve task details. If the task details
+ are not received within this period, the process will end, and a timeout notification will be logged.
+ type: int
+ default: 1200
+ dnac_task_poll_interval:
+ description: Specifies the interval in seconds between successive calls to the API to retrieve task details.
+ type: int
+ default: 2
validate_response_schema:
description:
- Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.
diff --git a/ansible_collections/cisco/dnac/plugins/doc_fragments/workflow_manager_params.py b/ansible_collections/cisco/dnac/plugins/doc_fragments/workflow_manager_params.py
new file mode 100644
index 000000000..8656bcb28
--- /dev/null
+++ b/ansible_collections/cisco/dnac/plugins/doc_fragments/workflow_manager_params.py
@@ -0,0 +1,117 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2021, Cisco Systems
+# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+__author__ = ['Madhan Sankaranarayanan, Muthu Rakesh']
+
+
+class ModuleDocFragment(object):
+
+ # Standard files documentation fragment
+ DOCUMENTATION = r'''
+options:
+ dnac_host:
+ description:
+ - The hostname of the Cisco Catalyst Center.
+ type: str
+ required: true
+ dnac_port:
+ description:
+ - Specifies the port number associated with the Cisco Catalyst Center.
+ type: str
+ default: '443'
+ dnac_username:
+ description:
+ - The username for authentication at the Cisco Catalyst Center.
+ type: str
+ default: admin
+ aliases: [ user ]
+ dnac_password:
+ description:
+ - The password for authentication at the Cisco Catalyst Center.
+ type: str
+ dnac_verify:
+ description:
+ - Flag to enable or disable SSL certificate verification.
+ type: bool
+ default: true
+ dnac_version:
+ description:
+ - Specifies the version of the Cisco Catalyst Center that the SDK should use.
+ type: str
+ default: 2.2.3.3
+ dnac_debug:
+ description:
+ - Indicates whether debugging is enabled in the Cisco Catalyst Center SDK.
+ type: bool
+ default: false
+ dnac_log:
+ description:
+ - Flag to enable/disable playbook execution logging.
+ - When true and dnac_log_file_path is provided,
+ - Create the log file at the execution location with the specified name.
+ - When true and dnac_log_file_path is not provided,
+ - Create the log file at the execution location with the name 'dnac.log'.
+ - When false,
+ - Logging is disabled.
+ - If the log file doesn't exist,
+ - It is created in append or write mode based on the "dnac_log_append" flag.
+ - If the log file exists,
+ - It is overwritten or appended based on the "dnac_log_append" flag.
+ type: bool
+ default: false
+ dnac_log_level:
+ 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 Catalyst Center SDK to enable the validation of request bodies against a JSON schema.
+ type: bool
+ default: true
+ dnac_api_task_timeout:
+ description: Defines the timeout in seconds for API calls to retrieve task details. If the task details
+ are not received within this period, the process will end, and a timeout notification will be logged.
+ type: int
+ default: 1200
+ dnac_task_poll_interval:
+ description: Specifies the interval in seconds between successive calls to the API to retrieve task details.
+ type: int
+ default: 2
+notes:
+ - "Does not support C(check_mode)"
+ - "The plugin runs on the control node and does not use any ansible connection plugins instead embedded connection manager from Cisco Catalyst Center SDK"
+ - "The parameters starting with dnac_ are used by the Cisco Catalyst Center Python SDK to establish the connection"
+'''