cisco.dnac.ise_radius_integration_playbook_config_generator module -- Generate YAML configurations playbook for 'ise_radius_integration_workflow_manager' module.
Note
This module is part of the cisco.dnac collection (version 6.49.0).
To install it, use: ansible-galaxy collection install cisco.dnac.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.dnac.ise_radius_integration_playbook_config_generator.
New in cisco.dnac 6.45.0
Synopsis
Generates a YAML playbook for Authentication and Policy Servers that can be used with the ISE RADIUS integration workflow manager module.
Retrieves existing server configurations from Cisco Catalyst Center and transforms them into a YAML format compatible with the
ise_radius_integration_workflow_managermodule.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.10.10
python >= 3.9
Parameters
Parameter |
Comments |
|---|---|
A dictionary of filters for generating YAML playbook compatible with the `ise_radius_integration_workflow_manager` module. Filters specify which components to include in the YAML configuration file. When |
|
Filters to specify which components to include in the YAML configuration file. When |
|
Authentication and policy server filter with server_type and server_ip_address. |
|
Server IP address to filter authentication and policy servers by IP address. |
|
Server type to filter authentication and policy servers by server_type. ISE for Cisco ISE servers. AAA for Non-Cisco ISE servers. Choices: |
|
List of components to include in the YAML configuration file. Valid value is If omitted, all components are included. Example: Choices: |
|
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. Default: :ansible-option-default:`1200` |
|
Indicates whether debugging is enabled in the Cisco Catalyst Center SDK. Choices: |
|
The hostname of the Cisco Catalyst Center. |
|
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. Choices: |
|
Determines the mode of the file. Set to True for 'append' mode. Set to False for 'write' mode. Choices: |
|
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. Default: :ansible-option-default:`"dnac.log"` |
|
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. Default: :ansible-option-default:`"WARNING"` |
|
The password for authentication at the Cisco Catalyst Center. |
|
Specifies the port number associated with the Cisco Catalyst Center. Default: :ansible-option-default:`"443"` |
|
Specifies the interval in seconds between successive calls to the API to retrieve task details. Default: :ansible-option-default:`2` |
|
The username for authentication at the Cisco Catalyst Center. Default: :ansible-option-default:`"admin"` |
|
Flag to enable or disable SSL certificate verification. Choices: |
|
Specifies the version of the Cisco Catalyst Center that the SDK should use. Default: :ansible-option-default:`"2.2.3.3"` |
|
Determines how the output YAML configuration file is written. When set to When set to Choices: |
|
Path where the YAML configuration file will be saved. If not provided, the file will be saved in the current working directory with a default file name For example, |
|
The desired state of Cisco Catalyst Center after module execution. Choices: |
|
Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: |
Notes
Note
SDK Methods used are - system_settings.SystemSettings.get_authentication_and_policy_servers
Paths used are get /dna/intent/api/v1/authentication-policy-servers
Does not support
check_modeThe 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
See Also
See also
- cisco.dnac.ise_radius_integration_workflow_manager
Module for managing ISE Radius Integration server.
Examples
- name: Generate YAML Configuration with File Path specified for all components
cisco.dnac.ise_radius_integration_playbook_config_generator:
dnac_host: "{{ dnac_host }}"
dnac_username: "{{ dnac_username }}"
dnac_password: "{{ dnac_password }}"
dnac_verify: "{{ dnac_verify }}"
dnac_port: "{{ dnac_port }}"
dnac_version: "{{ dnac_version }}"
dnac_debug: "{{ dnac_debug }}"
dnac_log: true
dnac_log_level: "{{ dnac_log_level }}"
state: gathered
config:
generate_all_configurations: true
- name: Generate YAML Configuration for all components with File Path specified
cisco.dnac.ise_radius_integration_playbook_config_generator:
dnac_host: "{{ dnac_host }}"
dnac_username: "{{ dnac_username }}"
dnac_password: "{{ dnac_password }}"
dnac_verify: "{{ dnac_verify }}"
dnac_port: "{{ dnac_port }}"
dnac_version: "{{ dnac_version }}"
dnac_debug: "{{ dnac_debug }}"
dnac_log: true
dnac_log_level: "{{ dnac_log_level }}"
state: gathered
file_path: "/tmp/ise_radius_integration_config.yaml"
file_mode: "overwrite"
config:
generate_all_configurations: true
- name: Generate YAML Configuration for mentioned components without File Path specified
cisco.dnac.ise_radius_integration_playbook_config_generator:
dnac_host: "{{ dnac_host }}"
dnac_username: "{{ dnac_username }}"
dnac_password: "{{ dnac_password }}"
dnac_verify: "{{ dnac_verify }}"
dnac_port: "{{ dnac_port }}"
dnac_version: "{{ dnac_version }}"
dnac_debug: "{{ dnac_debug }}"
dnac_log: true
dnac_log_level: "{{ dnac_log_level }}"
state: gathered
file_path: "/tmp/ise_radius_integration_config.yaml"
file_mode: "append"
config:
component_specific_filters:
components_list: ["authentication_policy_server"]
- name: Generate YAML Configuration for mentioned components with component and specific server_type filter
cisco.dnac.ise_radius_integration_playbook_config_generator:
dnac_host: "{{ dnac_host }}"
dnac_username: "{{ dnac_username }}"
dnac_password: "{{ dnac_password }}"
dnac_verify: "{{ dnac_verify }}"
dnac_port: "{{ dnac_port }}"
dnac_version: "{{ dnac_version }}"
dnac_debug: "{{ dnac_debug }}"
dnac_log: true
dnac_log_level: "{{ dnac_log_level }}"
state: gathered
file_path: "/tmp/ise_radius_integration_config.yaml"
file_mode: "append"
config:
component_specific_filters:
components_list: ["authentication_policy_server"]
authentication_policy_server:
server_type: "ISE"
- name: Generate YAML Configuration for mentioned components with component and specific server_ip_address filter
cisco.dnac.ise_radius_integration_playbook_config_generator:
dnac_host: "{{ dnac_host }}"
dnac_username: "{{ dnac_username }}"
dnac_password: "{{ dnac_password }}"
dnac_verify: "{{ dnac_verify }}"
dnac_port: "{{ dnac_port }}"
dnac_version: "{{ dnac_version }}"
dnac_debug: "{{ dnac_debug }}"
dnac_log: true
dnac_log_level: "{{ dnac_log_level }}"
state: gathered
file_path: "/tmp/ise_radius_integration_config.yaml"
file_mode: "append"
config:
component_specific_filters:
components_list: ["authentication_policy_server"]
authentication_policy_server:
server_ip_address: 10.197.156.10
- name: Generate YAML Configuration for mentioned components with component and specific server_type and server_ip_address filter
cisco.dnac.ise_radius_integration_playbook_config_generator:
dnac_host: "{{ dnac_host }}"
dnac_username: "{{ dnac_username }}"
dnac_password: "{{ dnac_password }}"
dnac_verify: "{{ dnac_verify }}"
dnac_port: "{{ dnac_port }}"
dnac_version: "{{ dnac_version }}"
dnac_debug: "{{ dnac_debug }}"
dnac_log: true
dnac_log_level: "{{ dnac_log_level }}"
state: gathered
file_path: "/tmp/ise_radius_integration_config.yaml"
file_mode: "append"
config:
component_specific_filters:
components_list: ["authentication_policy_server"]
authentication_policy_server:
server_type: "ISE"
server_ip_address: 10.197.156.10
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary with with the response returned by the Cisco Catalyst Center Python SDK Returned: always |
|
A string with the message returned by the Cisco Catalyst Center Python SDK Returned: always |