Note
This plugin is part of the community.network collection (version 3.0.0).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install community.network.
To use it in a playbook, specify: community.network.icx_system.
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| aaa_servers list / elements=string | Configures radius/tacacs server | ||
| acct_port_num string | Configures the accounting UDP port. The default value is 1813. | ||
| acct_type string |
| Usage of the accounting port. | |
| auth_key string | Configure the key for the server | ||
| auth_key_type list / elements=string |
| List of authentication level specified in the choices | |
| auth_port_num string | Configures the authentication UDP port. The default value is 1812. | ||
| auth_port_type string |
| specifies the type of the authentication port | |
| hostname string | Configures the host name of the RADIUS server | ||
| type string |
| specify the type of the server | |
| check_running_config boolean |
| Check running configuration. This can be set as environment variable. Module will use environment variable value(default:True), unless it is overridden, by specifying it as module parameter. | |
| domain_name list / elements=string | Configure the IP domain name on the remote device to the provided value. Value should be in the dotted name form and will be appended to the hostname to create a fully-qualified domain name. | ||
| domain_search list / elements=string | Provides the list of domain names to append to the hostname for the purpose of doing name resolution. This argument accepts a list of names and will be reconciled with the current active configuration on the running node. | ||
| hostname string | Configure the device hostname parameter. This option takes an ASCII string value. | ||
| name_servers list / elements=string | List of DNS name servers by IP address to use to perform name resolution lookups. | ||
| state string |
| State of the configuration values in the device's current active configuration. When set to present, the values should be configured in the device active configuration and when set to absent the values should not be in the device active configuration | |
Note
- name: Configure hostname and domain name
community.network.icx_system:
hostname: icx
domain_search:
- ansible.com
- redhat.com
- ruckus.com
- name: Configure radius server of type auth-port
community.network.icx_system:
aaa_servers:
- type: radius
hostname: radius-server
auth_port_type: auth-port
auth_port_num: 1821
acct_port_num: 1321
acct_type: accounting-only
auth_key: abc
auth_key_type:
- dot1x
- mac-auth
- name: Configure tacacs server
community.network.icx_system:
aaa_servers:
- type: tacacs
hostname: tacacs-server
auth_port_type: auth-port
auth_port_num: 1821
acct_port_num: 1321
acct_type: accounting-only
auth_key: xyz
- name: Configure name servers
community.network.icx_system:
name_servers:
- 8.8.8.8
- 8.8.4.4
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| commands list / elements=string | always | The list of configuration mode commands to send to the device Sample: ['hostname icx', 'ip domain name test.example.com', 'radius-server host 172.16.10.12 auth-port 2083 acct-port 1850 default key abc dot1x mac-auth', 'tacacs-server host 10.2.3.4 auth-port 4058 authorization-only key xyz'] |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/icx_system_module.html