FileMgr

✏️ /usr/lib/python3.9/site-packages/ansible_collections/arista/eos/plugins/modules/eos_interfaces.py

✕ Tutup

# -*- coding: utf-8 -*-
# Copyright 2019 Red Hat
# GNU General Public License v3.0+
# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

##############################################
#                 WARNING                    #
##############################################
#
# This file is auto generated by the resource
#   module builder playbook.
#
# Do not edit this file manually.
#
# Changes to this file will be over written
#   by the resource module builder.
#
# Changes should be made in the model used to
#   generate this file or in the resource module
#   builder template.
#
##############################################

"""
The module file for eos_interfaces
"""

from __future__ import absolute_import, division, print_function

__metaclass__ = type

DOCUMENTATION = """
module: eos_interfaces
short_description: Interfaces resource module
description:
- This module manages the interface attributes of Arista EOS interfaces.
version_added: 1.0.0
author:
- Nathaniel Case (@qalthos)
notes:
- Tested against Arista EOS 4.24.6F
- This module works with connection C(network_cli). See the L(EOS Platform Options,../network/user_guide/platform_eos.html).
options:
  config:
    description: The provided configuration
    type: list
    elements: dict
    suboptions:
      name:
        description:
        - Full name of the interface, e.g. GigabitEthernet1.
        type: str
        required: True
      description:
        description:
        - Interface description
        type: str
      duplex:
        description:
        - Interface link status. Applicable for Ethernet interfaces only.
        - Values other than C(auto) must also set I(speed).
        - Ignored when I(speed) is set above C(1000).
        type: str
      enabled:
        default: true
        description:
        - Administrative state of the interface.
        - Set the value to C(true) to administratively enable the interface or C(false)
          to disable it.
        type: bool
      mtu:
        description:
        - MTU for a specific interface. Must be an even number between 576 and 9216.
          Applicable for Ethernet interfaces only.
        type: int
      speed:
        description:
        - Interface link speed. Applicable for Ethernet interfaces only.
        type: str
      mode:
        description:
        - Manage Layer2 or Layer3 state of the interface. Applicable for Ethernet
          and port channel interfaces only.
        choices:
        - layer2
        - layer3
        type: str
  running_config:
    description:
    - This option is used only with state I(parsed).
    - The value of this option should be the output received from the EOS device by
      executing the command B(show running-config | section ^interface).
    - The state I(parsed) reads the configuration from C(running_config) option and
      transforms it into Ansible structured data as per the resource module's argspec
      and the value is then returned in the I(parsed) key within the result.
    type: str
  state:
    choices:
    - merged
    - replaced
    - overridden
    - deleted
    - parsed
    - rendered
    - gathered
    default: merged
    description:
    - The state of the configuration after module completion.
    type: str

"""

EXAMPLES = """

# Using merged

# Before state:
# -------------
#
# veos#show running-config | section interface
# interface Ethernet1
#    description "Interface 1"
# !
# interface Ethernet2
# !
# interface Management1
#    description "Management interface"
#    ip address dhcp
# !

- name: Merge provided configuration with device configuration
  arista.eos.eos_interfaces:
    config:
    - name: Ethernet1
      enabled: true
      mode: layer3
    - name: Ethernet2
      description: Configured by Ansible
      enabled: false
    state: merged

# After state:
# ------------
#
# veos#show running-config | section interface
# interface Ethernet1
#    description "Interface 1"
#    no switchport
# !
# interface Ethernet2
#    description "Configured by Ansible"
#    shutdown
# !
# interface Management1
#    description "Management interface"
#    ip address dhcp
# !

# Using replaced

- name: Replaces device configuration of listed interfaces with provided configuration
  arista.eos.eos_interfaces:
    config:
    - name: Ethernet1
      enabled: true
    - name: Ethernet2
      description: Configured by Ansible
      enabled: false
    state: replaced

# After state:
# ------------
#
# veos#show running-config | section interface
# interface Ethernet1
# !
# interface Ethernet2
#    description "Configured by Ansible"
#    shutdown
# !
# interface Management1
#    description "Management interface"
#    ip address dhcp
# !

# Using overridden

- name: Overrides all device configuration with provided configuration
  arista.eos.eos_interfaces:
    config:
    - name: Ethernet1
      enabled: true
    - name: Ethernet2
      description: Configured by Ansible
      enabled: false
    state: overridden

# Using deleted

# Before state:
# -------------
#
# veos#show running-config | section interface
# interface Ethernet1
#    description "Interface 1"
#    no switchport
# !
# interface Ethernet2
# !
# interface Management1
#    description "Management interface"
#    ip address dhcp
# !

- name: Delete or return interface parameters to default settings
  arista.eos.eos_interfaces:
    config:
    - name: Ethernet1
    state: deleted

# After state:
# ------------
#
# veos#show running-config | section interface
# interface Ethernet1
# !
# interface Ethernet2
# !
# interface Management1
#    description "Management interface"
#    ip address dhcp
# !

# Using rendered

- name: Use Rendered to convert the structured data to native config
  arista.eos.eos_interfaces:
    config:
    - name: Ethernet1
      enabled: true
      mode: layer3
    - name: Ethernet2
      description: Configured by Ansible
      enabled: false
    state: merged

# Output:
# ------------

# - "interface Ethernet1"
# - "description "Interface 1""
# - "no swithcport"
# - "interface Ethernet2"
# - "description "Configured by Ansible""
# - "shutdown"
# - "interface Management1"
# - "description "Management interface""
# - "ip address dhcp"

# Using parsed
# parsed.cfg

# interface Ethernet1
#    description "Interface 1"
# !
# interface Ethernet2
#    description "Configured by Ansible"
#    shutdown
# !

- name: Use parsed to convert native configs to structured data
  arista.eos.interfaces:
    running_config: "{{ lookup('file', 'parsed.cfg') }}"
    state: parsed

# Output
# parsed:
#     - name: Ethernet1
#       enabled: True
#       mode: layer2
#     - name: Ethernet2
#       description: 'Configured by Ansible'
#       enabled: False
#       mode: layer2

# Using gathered:

# Existing config on the device
# -----------------------------
# interface Ethernet1
#    description "Interface 1"
# !
# interface Ethernet2
#    description "Configured by Ansible"
#    shutdown
# !

- name: Gather interfaces facts from the device
  arista.eos.interfaces:
    state: gathered

# output
# gathered:
#      - name: Ethernet1
#        enabled: True
#        mode: layer2
#      - name: Ethernet2
#        description: 'Configured by Ansible'
#        enabled: False
#        mode: layer2
"""

RETURN = """
before:
  description: The configuration as structured data prior to module invocation.
  returned: always
  type: dict
  sample: The configuration returned will always be in the same format of the parameters above.
after:
  description: The configuration as structured data after module completion.
  returned: when changed
  type: dict
  sample: The configuration returned will always be in the same format of the parameters above.
commands:
  description: The set of commands pushed to the remote device.
  returned: always
  type: list
  sample: ['interface Ethernet2', 'shutdown', 'speed 10full']
"""

from ansible.module_utils.basic import AnsibleModule

from ansible_collections.arista.eos.plugins.module_utils.network.eos.argspec.interfaces.interfaces import (
    InterfacesArgs,
)
from ansible_collections.arista.eos.plugins.module_utils.network.eos.config.interfaces.interfaces import (
    Interfaces,
)

def main():
    """
    Main entry point for module execution

:returns: the result form module invocation
    """

required_if = [
        ("state", "merged", ("config",)),
        ("state", "replaced", ("config",)),
        ("state", "overridden", ("config",)),
        ("state", "rendered", ("config",)),
        ("state", "parsed", ("running_config",)),
    ]
    mutually_exclusive = [("config", "running_config")]

module = AnsibleModule(
        argument_spec=InterfacesArgs.argument_spec,
        required_if=required_if,
        supports_check_mode=True,
        mutually_exclusive=mutually_exclusive,
    )

result = Interfaces(module).execute_module()
    module.exit_json(**result)

if __name__ == "__main__":
    main()

Batal

⬅ plugins 36 item

Nama	Tipe	Ukuran	Diubah	Perm	Aksi
📁 __pycache__	dir	—	16/09/24 06:47	0755	📂
🐍 __init__.py	py	0 B	08/11/23 12:12	0644	✏️ ⬇
🐍 eos_acl_interfaces.py	py	9.5 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 eos_acls.py	py	28 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 eos_banner.py	py	5.6 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 eos_bgp.py	py	14 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 eos_bgp_address_family.py	py	39.5 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 eos_bgp_global.py	py	84.4 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 eos_command.py	py	10.2 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 eos_config.py	py	23.1 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 eos_eapi.py	py	14.2 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 eos_facts.py	py	6.2 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 eos_hostname.py	py	9.4 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 eos_interfaces.py	py	9.5 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 eos_l2_interfaces.py	py	10 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 eos_l3_interfaces.py	py	9.6 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 eos_lacp.py	py	5.6 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 eos_lacp_interfaces.py	py	7.5 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 eos_lag_interfaces.py	py	7.8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 eos_lldp.py	py	2.7 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 eos_lldp_global.py	py	8.3 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 eos_lldp_interfaces.py	py	7.4 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 eos_logging.py	py	12.6 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 eos_logging_global.py	py	26.5 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 eos_ntp_global.py	py	30 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 eos_ospf_interfaces.py	py	35.2 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 eos_ospfv2.py	py	51 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 eos_ospfv3.py	py	53.8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 eos_prefix_lists.py	py	36 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 eos_route_maps.py	py	42.8 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 eos_snmp_server.py	py	49.1 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 eos_static_routes.py	py	30.3 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 eos_system.py	py	11.9 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 eos_user.py	py	15.4 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 eos_vlans.py	py	6.7 KB	08/11/23 12:12	0644	✏️ ⬇
🐍 eos_vrf.py	py	12.2 KB	08/11/23 12:12	0644	✏️ ⬇

✏️ Rename

🔑 Ubah Permission