mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-26 12:21:26 -07:00
38c0b581c3
* Handle common agrument in aggregate parameter for vyos module * Add supoort to set parameter in aggregate to it's respctive top level argument if value not provided in aggregate. * Aggregate argument spec validation * Documentation for aggregate * Fix unit test failure
118 lines
2.7 KiB
Python
118 lines
2.7 KiB
Python
#!/usr/bin/python
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# (c) 2017, Ansible by Red Hat, inc
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
from __future__ import absolute_import, division, print_function
|
|
__metaclass__ = type
|
|
|
|
|
|
ANSIBLE_METADATA = {'metadata_version': '1.0',
|
|
'status': ['preview'],
|
|
'supported_by': 'core'}
|
|
|
|
|
|
DOCUMENTATION = """
|
|
---
|
|
module: net_interface
|
|
version_added: "2.4"
|
|
author: "Ganesh Nalawade (@ganeshrn)"
|
|
short_description: Manage Interface on network devices
|
|
description:
|
|
- This module provides declarative management of Interfaces
|
|
on network devices.
|
|
options:
|
|
name:
|
|
description:
|
|
- Name of the Interface.
|
|
required: true
|
|
description:
|
|
description:
|
|
- Description of Interface.
|
|
enabled:
|
|
description:
|
|
- Configure interface link status.
|
|
speed:
|
|
description:
|
|
- Interface link speed.
|
|
mtu:
|
|
description:
|
|
- Maximum size of transmit packet.
|
|
duplex:
|
|
description:
|
|
- Interface link status
|
|
default: auto
|
|
choices: ['full', 'half', 'auto']
|
|
tx_rate:
|
|
description:
|
|
- Transmit rate
|
|
rx_rate:
|
|
description:
|
|
- Receiver rate
|
|
aggregate:
|
|
description: List of Interfaces definitions.
|
|
purge:
|
|
description:
|
|
- Purge Interfaces not defined in the aggregate parameter.
|
|
This applies only for logical interface.
|
|
default: no
|
|
state:
|
|
description:
|
|
- State of the Interface configuration, C(up) indicates present and
|
|
operationally up and C(down) indicates present and operationally C(down)
|
|
default: present
|
|
choices: ['present', 'absent', 'up', 'down']
|
|
"""
|
|
|
|
EXAMPLES = """
|
|
- name: configure interface
|
|
net_interface:
|
|
name: ge-0/0/1
|
|
description: test-interface
|
|
|
|
- name: remove interface
|
|
net_interface:
|
|
name: ge-0/0/1
|
|
state: absent
|
|
|
|
- name: make interface up
|
|
net_interface:
|
|
name: ge-0/0/1
|
|
description: test-interface
|
|
enabled: True
|
|
|
|
- name: make interface down
|
|
net_interface:
|
|
name: ge-0/0/1
|
|
description: test-interface
|
|
enabled: False
|
|
|
|
- name: Create interface using aggregate
|
|
net_interface:
|
|
aggregate:
|
|
- name: ge-0/0/1
|
|
description: test-interface-1
|
|
- name: ge-0/0/2
|
|
description: test-interface-2
|
|
speed: 1g
|
|
duplex: full
|
|
mtu: 512
|
|
|
|
- name: Delete interface using aggregate
|
|
junos_interface:
|
|
aggregate:
|
|
- name: ge-0/0/1
|
|
- name: ge-0/0/2
|
|
state: absent
|
|
"""
|
|
|
|
RETURN = """
|
|
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.
|
|
type: list
|
|
sample:
|
|
- interface 20
|
|
- name test-interface
|
|
"""
|