community.general.icx_l3_interface (0.1.1) — module

Manage Layer-3 interfaces on Ruckus ICX 7000 series switches

Authors: Ruckus Wireless (@Commscope)

preview | supported by community

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 Layer-3 interfaces on ICX network devices.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Remove ethernet 1/1/1 IPv4 and IPv6 address
  icx_l3_interface:
    name: ethernet 1/1/1
    ipv4: 192.168.0.1/24
    ipv6: "fd5d:12c9:2201:1::1/64"
    state: absent
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Replace ethernet 1/1/1 primary IPv4 address
  icx_l3_interface:
    name: ethernet 1/1/1
    ipv4: 192.168.0.1/24
    replace: yes
    state: absent
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Replace ethernet 1/1/1 dynamic IPv4 address
  icx_l3_interface:
    name: ethernet 1/1/1
    ipv4: 192.168.0.1/24
    mode: dynamic
    state: absent
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Set ethernet 1/1/1 secondary IPv4 address
  icx_l3_interface:
    name: ethernet 1/1/1
    ipv4: 192.168.0.1/24
    secondary: yes
    state: absent
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Set ethernet 1/1/1 IPv4 address
  icx_l3_interface:
    name: ethernet 1/1/1
    ipv4: 192.168.0.1/24
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Set ethernet 1/1/1 IPv6 address
  icx_l3_interface:
    name: ethernet 1/1/1
    ipv6: "fd5d:12c9:2201:1::1/64"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Set IP addresses on aggregate
  icx_l3_interface:
    aggregate:
      - { name: GigabitEthernet0/3, ipv4: 192.168.2.10/24 }
      - { name: GigabitEthernet0/3, ipv4: 192.168.3.10/24, ipv6: "fd5d:12c9:2201:1::1/64" }
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Remove IP addresses on aggregate
  icx_l3_interface:
    aggregate:
      - { name: GigabitEthernet0/3, ipv4: 192.168.2.10/24 }
      - { name: GigabitEthernet0/3, ipv4: 192.168.3.10/24, ipv6: "fd5d:12c9:2201:1::1/64" }
    state: absent
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Set the ipv4 and ipv6 of a virtual ethernet(ve)
  icx_l3_interface:
    name: ve 100
    ipv4: 192.168.0.1
    ipv6: "2001:0db8:85a3:0000:0000:8a2e:0370:7334"

Inputs

    
ipv4:
    description:
    - IPv4 address to be set for the Layer-3 interface mentioned in I(name) option. The
      address format is <ipv4 address>/<mask>, the mask is number in range 0-32 eg. 192.168.0.1/24
    type: str

ipv6:
    description:
    - IPv6 address to be set for the Layer-3 interface mentioned in I(name) option. The
      address format is <ipv6 address>/<mask>, the mask is number in range 0-128 eg. fd5d:12c9:2201:1::1/64.
    type: str

mode:
    choices:
    - dynamic
    - ospf-ignore
    - ospf-passive
    description:
    - Specifies if ipv4 address should be dynamic/advertise to ospf/not advertise to ospf.
      This should be specified only if ipv4 address is configured and if it is not secondary
      IP address.
    type: str

name:
    description:
    - Name of the Layer-3 interface to be configured eg. GigabitEthernet0/2, ve 10, ethernet
      1/1/1
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - State of the Layer-3 interface configuration. It indicates if the configuration
      should be present or absent on remote device.
    type: str

replace:
    choices:
    - 'yes'
    - 'no'
    description:
    - Replaces the configured primary IP address on the interface.
    type: str

aggregate:
    description:
    - List of Layer-3 interfaces definitions. Each of the entry in aggregate list should
      define name of interface C(name) and a optional C(ipv4) or C(ipv6) address.
    suboptions:
      check_running_config:
        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
      ipv4:
        description:
        - IPv4 address to be set for the Layer-3 interface mentioned in I(name) option.
          The address format is <ipv4 address>/<mask>, the mask is number in range 0-32
          eg. 192.168.0.1/24
        type: str
      ipv6:
        description:
        - IPv6 address to be set for the Layer-3 interface mentioned in I(name) option.
          The address format is <ipv6 address>/<mask>, the mask is number in range 0-128
          eg. fd5d:12c9:2201:1::1/64.
        type: str
      mode:
        choices:
        - dynamic
        - ospf-ignore
        - ospf-passive
        description:
        - Specifies if ipv4 address should be dynamic/advertise to ospf/not advertise
          to ospf. This should be specified only if ipv4 address is configured and if
          it is not secondary IP address.
        type: str
      name:
        description:
        - Name of the Layer-3 interface to be configured eg. GigabitEthernet0/2, ve 10,
          ethernet 1/1/1
        type: str
      replace:
        choices:
        - 'yes'
        - 'no'
        description:
        - Replaces the configured primary IP address on the interface.
        type: str
      secondary:
        choices:
        - 'yes'
        - 'no'
        description:
        - Specifies that the configured address is a secondary IP address. If this keyword
          is omitted, the configured address is the primary IP address.
        type: str
      state:
        choices:
        - present
        - absent
        description:
        - State of the Layer-3 interface configuration. It indicates if the configuration
          should be present or absent on remote device.
        type: str
    type: list

secondary:
    choices:
    - 'yes'
    - 'no'
    description:
    - Specifies that the configured address is a secondary IP address. If this keyword
      is omitted, the configured address is the primary IP address.
    type: str

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, except for the platforms that use Netconf transport to manage
    the device.
  sample:
  - interface ethernet 1/1/1
  - ip address 192.168.0.1 255.255.255.0
  - ipv6 address fd5d:12c9:2201:1::1/64
  type: list