community.general.icx_system (0.1.1) — module

Install collection

Install with ansible-galaxy collection install community.general:==0.1.1

Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.1

Description

This module provides declarative management of node system attributes on Ruckus ICX 7000 series switches. It provides an option to configure host system parameters or remove those parameters from the device active configuration.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: configure hostname and domain name
  icx_system:
    hostname: icx
    domain_search:
      - ansible.com
      - redhat.com
      - ruckus.com

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: configure radius server of type auth-port
  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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: configure tacacs server
  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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: configure name servers
  icx_system:
    name_servers:
      - 8.8.8.8
      - 8.8.4.4

Inputs

    
state:
    choices:
    - present
    - absent
    default: present
    description:
    - State of the configuration values in the device's current active configuration.  When
      set to I(present), the values should be configured in the device active configuration
      and when set to I(absent) the values should not be in the device active configuration
    type: str

hostname:
    description:
    - Configure the device hostname parameter. This option takes an ASCII string value.
    type: str

aaa_servers:
    description:
    - Configures radius/tacacs server
    suboptions:
      acct_port_num:
        description:
        - Configures the accounting UDP port. The default value is 1813.
        type: str
      acct_type:
        choices:
        - accounting-only
        - authentication-only
        - authorization-only
        - default
        description:
        - Usage of the accounting port.
        type: str
      auth_key:
        description:
        - Configure the key for the server
        type: str
      auth_key_type:
        choices:
        - dot1x
        - mac-auth
        - web-auth
        description:
        - List of authentication level specified in the choices
        type: list
      auth_port_num:
        description:
        - Configures the authentication UDP port. The default value is 1812.
        type: str
      auth_port_type:
        choices:
        - auth-port
        description:
        - specifies the type of the authentication port
        type: str
      hostname:
        description:
        - Configures the host name of the RADIUS server
        type: str
      type:
        choices:
        - radius
        - tacacs
        description:
        - specify the type of the server
        type: str
    type: list

domain_name:
    description:
    - 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.
    type: list

name_servers:
    description:
    - List of DNS name servers by IP address to use to perform name resolution lookups.
    type: list

domain_search:
    description:
    - 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.
    type: list

check_running_config:
    default: true
    description:
    - 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.
    type: bool

Outputs

commands:
  description: The list of configuration mode commands to send to the device
  returned: always
  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
  type: list