Skip to content

commscope-ruckus/RUCKUS_ICX_Ansible

Repository files navigation

Commscope ICX collection

The Ansible Commscope ICX collection includes a variety of Ansible content to help automate the management of Commscope ICX network devices.

This collection has been tested against Commscope ICX version 08.0.95

Ansible version compatability

This collection has been tested against following Ansible versions: >=2.9.10.

Plugins and modules within a collection may be tested with only specific Ansible versions. A collection may contain metadata that identifies these versions. PEP440 is the schema used to describe the versions of Ansible.

Supported connections

The Commscope ICX collection supports network_cli connections.

Included content

Cliconf plugins

Name Description
commscope.icx.icx Use icx cliconf to run command on Commscope ICX platform

Modules

Name Description
commscope.icx.icx_banner Manage multiline banners on Ruckus ICX 7K series switches
commscope.icx.icx_command Run arbitrary commands on remote Ruckus ICX 7K series switches
commscope.icx.icx_config Manage configuration sections of Ruckus ICX 7K series switches
commscope.icx.icx_copy Transfer files from or to remote Ruckus ICX 7K series switches
commscope.icx.icx_facts Collect facts from remote Ruckus ICX 7K series switches
commscope.icx.icx_firmware_upgrade Upgrades firmware of Ruckus ICX 7K series switches
commscope.icx.icx_interface Manage Interface on Ruckus ICX 7K series switches
commscope.icx.icx_l3_interface Manage Layer-3 interfaces on Ruckus ICX 7K series switches
commscope.icx.icx_linkagg Manage link aggregation groups on Ruckus ICX 7K series switches
commscope.icx.icx_lldp Manage LLDP configuration on Ruckus ICX 7K series switches
commscope.icx.icx_logging Manage logging on Ruckus ICX 7K series switches
commscope.icx.icx_ping Tests reachability using ping from Ruckus ICX 7K series switches
commscope.icx.icx_qos Configures qos features on ICX 7K series switches
commscope.icx.icx_rate_limit Configures rate limit on ICX 7K switch
commscope.icx.icx_static_route Manage static IP routes on Ruckus ICX 7K series switches
commscope.icx.icx_static_route6 Manage static IPV6 routes on Ruckus ICX 7K series switches
commscope.icx.icx_system Manage the system attributes on Ruckus ICX 7K series switches
commscope.icx.icx_user Manage the user accounts on Ruckus ICX 7K series switches
commscope.icx.icx_vlan Manage VLANs on Ruckus ICX 7K series switches

Installing this collection

You can install the Commscope ICX collection with the Ansible Galaxy CLI:

ansible-galaxy collection install commscope.icx

You can also include it in a requirements.yml file and install it with ansible-galaxy collection install -r requirements.yml, using the format:

---
collections:
  - name: commscope.icx

Using this collection

This collection includes network resource modules.

Using modules from the Commscope ICX collection in your playbooks

You can call modules by their Fully Qualified Collection Namespace (FQCN), such as commscope.icx.icx_vlan. The following example task replaces configuration changes in the existing configuration on a RUCKUS ICX switch, using the FQCN:

---
  - name: Add a single ethernet 1/1/48 as access(untagged) port to vlan 20
    commscope.icx.icx_vlan:
      name: test-vlan
      vlan_id: 20
      interfaces:
        name:
          - ethernet 1/1/48

NOTE: For Ansible 2.9, you may not see deprecation warnings when you run your playbooks with this collection. Use this documentation to track when a module is deprecated.

See Also:

Contributing to this collection

If you find problems, please open an issue against the Commscope ICX collection repository.

See the Ansible Community Guide for details on contributing to Ansible.

Code of Conduct

This collection follows the Ansible project's Code of Conduct. Please read and familiarize yourself with this document.

Release notes

Release notes will be added soon.

Roadmap

More information

Licensing

GNU General Public License v3.0 or later.

See LICENSE to see the full text.