iosxr_l3_interfaces – Manage Layer-3 interface on Cisco IOS-XR devices — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# iosxr_l3_interfaces – Manage Layer-3 interface on Cisco IOS-XR devices

New in version 2.9.

- Synopsis
- Parameters
- Notes
- Examples
- Return Values
- Status

## Synopsis

- This module provides declarative management of Layer-3 interface on Cisco IOS-XR devices.

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
config list / elements=dictionary |  | A dictionary of Layer-3 interface options
| ipv4 list |  | IPv4 address to be set for the Layer-3 interface mentioned in name option. The address format is <ipv4 address>/<mask>, the mask is number in range 0-32 eg. 192.168.0.1/24
|  | address string |  | Configures the IPv4 address for Interface.
|  | secondary boolean | Choices: no yes | Configures the IP address as a secondary address.
| ipv6 list |  | IPv6 address to be set for the Layer-3 interface mentioned in name option. The address format is <ipv6 address>/<mask>, the mask is number in range 0-128 eg. fd5d:12c9:2201:1::1/64
|  | address string |  | Configures the IPv6 address for Interface.
| name string / required |  | Full name of the interface excluding any logical unit number, i.e. GigabitEthernet0/1.
state string | Choices: merged ← replaced overridden deleted | The state of the configuration after module completion

## Notes

Note

- Tested against Cisco IOS-XRv Version 6.1.3 on VIRL.
- This module works with connection `network_cli`. See the IOS-XR Platform Options.

## Examples

    ---
    # Using merged

    # Before state:
    # -------------
    #
    # viosxr#show running-config interface
    # interface GigabitEthernet0/0/0/1
    #  shutdown
    # !
    # interface GigabitEthernet0/0/0/2
    #  shutdown
    # !
    # interface GigabitEthernet0/0/0/3
    #  ipv4 address 192.168.0.2 255.255.255.0
    #  shutdown
    # !
    # interface GigabitEthernet0/0/0/3.700
    # !
    # interface GigabitEthernet0/0/0/4
    #  ipv6 address fd5d:12c9:2201:1::1/64
    #  shutdown
    # !

    - name: Merge provided configuration with device configuration
      iosxr_l3_interfaces:
        config:
          - name: GigabitEthernet0/0/0/2
            ipv4:
            - address: 192.168.0.1/24
          - name: GigabitEthernet0/0/0/3
            ipv4:
            - address: 192.168.2.1/24
              secondary: True
        state: merged

    # After state:
    # ------------
    #
    # viosxr#show running-config interface
    # interface GigabitEthernet0/0/0/1
    #  shutdown
    # !
    # interface GigabitEthernet0/0/0/2
    #  ipv4 address 192.168.0.1 255.255.255.0
    #  shutdown
    # !
    # interface GigabitEthernet0/0/0/3
    #  ipv4 address 192.168.1.0 255.255.255.0
    #  ipv4 address 192.168.2.1 255.255.255.0 secondary
    #  shutdown
    # !
    # interface GigabitEthernet0/0/0/3.700
    # !
    # interface GigabitEthernet0/0/0/4
    #  ipv6 address fd5d:12c9:2201:1::1/64
    #  shutdown
    # !

    # Using overridden

    # Before state:
    # -------------
    #
    # viosxr#show running-config interface
    # interface GigabitEthernet0/0/0/1
    #  shutdown
    # !
    # interface GigabitEthernet0/0/0/2
    #  ipv4 address 192.168.0.1 255.255.255.0
    #  shutdown
    # !
    # interface GigabitEthernet0/0/0/3
    #  ipv4 address 192.168.1.0 255.255.255.0
    #  shutdown
    # !
    # interface GigabitEthernet0/0/0/3.700
    # !
    # interface GigabitEthernet0/0/0/4
    #  ipv6 address fd5d:12c9:2201:1::1/64
    #  shutdown
    # !

    - name: Override device configuration of all interfaces with provided configuration
      iosxr_l3_interfaces:
        config:
          - name: GigabitEthernet0/0/0/3
            ipv4:
            - address: 192.168.0.1/24
          - name: GigabitEthernet0/0/0/3.700
            ipv4:
            - address: 192.168.0.2/24
            - address: 192.168.2.1/24
              secondary: True
        state: overridden

    # After state:
    # -------------
    #
    # viosxr#show running-config interface
    # interface GigabitEthernet0/0/0/1
    #  shutdown
    # !
    # interface GigabitEthernet0/0/0/2
    #  shutdown
    # !
    # interface GigabitEthernet0/0/0/3
    #  ipv4 address 192.168.0.1 255.255.255.0
    #  shutdown
    # !
    # interface GigabitEthernet0/0/0/3.700
    #  ipv4 address 192.168.0.2 255.255.255.0
    #  ipv4 address 192.168.2.1 255.255.255.0 secondary
    # !
    # interface GigabitEthernet0/0/0/4
    #  shutdown
    # !

    # Using replaced

    # Before state:
    # -------------
    #
    # viosxr#show running-config interface
    # interface GigabitEthernet0/0/0/1
    #  shutdown
    # !
    # interface GigabitEthernet0/0/0/2
    #  shutdown
    # !
    # interface GigabitEthernet0/0/0/3
    #  ipv4 address 192.168.0.2 255.255.255.0
    #  shutdown
    # !
    # interface GigabitEthernet0/0/0/3.700
    #  ipv4 address 192.168.0.1 255.255.255.0
    # !
    # interface GigabitEthernet0/0/0/4
    #  ipv6 address fd5d:12c9:2201:1::1/64
    #  shutdown
    # !

    - name: Replaces device configuration of listed interfaces with provided configuration
      iosxr_l3_interfaces:
        config:
          - name: GigabitEthernet0/0/0/3
            ipv6:
            - address: fd5d:12c9:2201:1::1/64
          - name: GigabitEthernet0/0/0/4
            ipv4:
            - address: 192.168.0.2/24
        state: replaced

    # After state:
    # -------------
    #
    # viosxr#show running-config interface
    # interface GigabitEthernet0/0/0/1
    #  shutdown
    # !
    # interface GigabitEthernet0/0/0/2
    #  shutdown
    # !
    # interface GigabitEthernet0/0/0/3
    #  ipv6 address fd5d:12c9:2201:1::1/64
    #  shutdown
    # !
    # interface GigabitEthernet0/0/0/3.700
    #  ipv4 address 192.168.0.1 255.255.255.0
    # !
    # interface GigabitEthernet0/0/0/4
    #  ipv4 address 192.168.0.2 255.255.255.0
    #  shutdown
    # !

    # Using deleted

    # Before state:
    # -------------
    #
    # viosxr#show running-config interface
    # interface GigabitEthernet0/0/0/1
    #  ipv4 address 192.168.2.1 255.255.255.0
    #  shutdown
    # !
    # interface GigabitEthernet0/0/0/2
    #  ipv4 address 192.168.3.1 255.255.255.0
    #  shutdown
    # !
    # interface GigabitEthernet0/0/0/3
    #  ipv4 address 192.168.0.2 255.255.255.0
    #  shutdown
    # !
    # interface GigabitEthernet0/0/0/3.700
    #  ipv4 address 192.168.0.1 255.255.255.0
    # !
    # interface GigabitEthernet0/0/0/4
    #  ipv6 address fd5d:12c9:2201:1::1/64
    #  shutdown
    # !

    - name: "Delete L3 attributes of given interfaces (Note: This won't delete the interface itself)"
      iosxr_l3_interfaces:
        config:
          - name: GigabitEthernet0/0/0/3
          - name: GigabitEthernet0/0/0/4
          - name: GigabitEthernet0/0/0/3.700
        state: deleted

    # After state:
    # -------------
    #
    # viosxr#show running-config interface
    # interface GigabitEthernet0/0/0/1
    #  ipv4 address 192.168.2.1 255.255.255.0
    #  shutdown
    # !
    # interface GigabitEthernet0/0/0/2
    #  ipv4 address 192.168.3.1 255.255.255.0
    #  shutdown
    # !
    # interface GigabitEthernet0/0/0/3
    #  shutdown
    # !
    # interface GigabitEthernet0/0/0/3.700
    # !
    # interface GigabitEthernet0/0/0/4
    #  shutdown
    # !

    # Using Deleted without any config passed
    # "(NOTE: This will delete all of configured resource module attributes from each configured interface)"

    # Before state:
    # -------------
    #
    # viosxr#show running-config interface
    # interface GigabitEthernet0/0/0/1
    #  ipv4 address 192.168.2.1 255.255.255.0
    #  shutdown
    # !
    # interface GigabitEthernet0/0/0/2
    #  ipv4 address 192.168.3.1 255.255.255.0
    #  shutdown
    # !
    # interface GigabitEthernet0/0/0/3
    #  ipv4 address 192.168.0.2 255.255.255.0
    #  shutdown
    # !
    # interface GigabitEthernet0/0/0/3.700
    #  ipv4 address 192.168.0.1 255.255.255.0
    # !
    # interface GigabitEthernet0/0/0/4
    #  ipv6 address fd5d:12c9:2201:1::1/64
    #  shutdown
    # !

    - name: "Delete L3 attributes of all interfaces (Note: This won't delete the interface itself)"
      iosxr_l3_interfaces:
        state: deleted

    # After state:
    # -------------
    #
    # viosxr#show running-config interface
    # interface GigabitEthernet0/0/0/1
    #  shutdown
    # !
    # interface GigabitEthernet0/0/0/2
    #  shutdown
    # !
    # interface GigabitEthernet0/0/0/3
    #  shutdown
    # !
    # interface GigabitEthernet0/0/0/3.700
    # !
    # interface GigabitEthernet0/0/0/4
    #  shutdown
    # !

## Return Values

Common return values are documented here, the following are the fields unique to this module:

Key | Returned | Description
--- | --- | ---
after list | when changed | The configuration as structured data after module completion. Sample: The configuration returned will always be in the same format of the parameters above.
before list | always | The configuration as structured data prior to module invocation. Sample: The configuration returned will always be in the same format of the parameters above.
commands list | always | The set of commands pushed to the remote device Sample: ['interface GigabitEthernet0/0/0/1', 'ipv4 address 192.168.0.1 255.255.255.0']

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Network Team. [network]

### Red Hat Support

More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.

### Authors

- Sumit Jaiswal (@justjais)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.