Pluribus Networks old modules to be deprecated (#51686)

* Pluribus Networks old modules to be deprecated

* Dox fixes
This commit is contained in:
rajaspachipulusu17 2019-02-12 13:43:22 +05:30 committed by Ganesh Nalawade
parent 48edffac60
commit a003de239d
11 changed files with 83 additions and 18 deletions

View file

@ -19,7 +19,7 @@
#
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'status': ['deprecated'],
'supported_by': 'community'}
@ -29,6 +29,10 @@ module: pn_cluster
author: "Pluribus Networks (@amitsi)"
version_added: "2.2"
short_description: CLI command to create/delete a cluster.
deprecated:
removed_in: '2.12'
why: Doesn't support latest Pluribus Networks netvisor
alternative: Latest modules will be pushed in Ansible future versions.
description:
- Execute cluster-create or cluster-delete command.
- A cluster allows two switches to cooperate in high-availability (HA)
@ -50,6 +54,7 @@ options:
description:
- Target switch to run the cli on.
required: False
default: 'local'
state:
description:
- Specify action to perform. Use 'present' to create cluster and 'absent'
@ -81,7 +86,7 @@ EXAMPLES = """
pn_name: 'spine-cluster'
pn_cluster_node1: 'spine01'
pn_cluster_node2: 'spine02'
pn_validate: validate
pn_validate: True
pn_quiet: True
- name: delete spine cluster

View file

@ -19,7 +19,7 @@
#
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'status': ['deprecated'],
'supported_by': 'community'}
@ -29,6 +29,10 @@ module: pn_ospf
author: "Pluribus Networks (@amitsi)"
version_added: "2.2"
short_description: CLI command to add/remove ospf protocol to a vRouter.
deprecated:
removed_in: '2.12'
why: Doesn't support latest Pluribus Networks netvisor
alternative: Latest modules will be pushed in Ansible future versions.
description:
- Execute vrouter-ospf-add, vrouter-ospf-remove command.
- This command adds/removes Open Shortest Path First(OSPF) routing
@ -46,6 +50,7 @@ options:
description:
- Target switch to run the CLI on.
required: False
default: 'local'
state:
description:
- Assert the state of the ospf. Use 'present' to add ospf

View file

@ -19,7 +19,7 @@
#
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'status': ['deprecated'],
'supported_by': 'community'}
@ -29,6 +29,10 @@ module: pn_ospfarea
author: "Pluribus Networks (@amitsi)"
version_added: "2.2"
short_description: CLI command to add/remove ospf area to/from a vrouter.
deprecated:
removed_in: '2.12'
why: Doesn't support latest Pluribus Networks netvisor
alternative: Latest modules will be pushed in Ansible future versions.
description:
- Execute vrouter-ospf-add, vrouter-ospf-remove command.
- This command adds/removes Open Shortest Path First(OSPF) area to/from
@ -74,8 +78,8 @@ options:
description:
- Enable/disable system information.
required: false
default: true
type: bool
default: true
"""
EXAMPLES = """

View file

@ -19,7 +19,7 @@
#
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'status': ['deprecated'],
'supported_by': 'community'}
@ -29,6 +29,10 @@ module: pn_show
author: "Pluribus Networks (@amitsi)"
version_added: "2.2"
short_description: Run show commands on nvOS device.
deprecated:
removed_in: '2.12'
why: Doesn't support latest Pluribus Networks netvisor
alternative: Latest modules will be pushed in Ansible future versions.
description:
- Execute show command in the nodes and returns the results
read from the device.
@ -51,8 +55,9 @@ options:
required: true
pn_parameters:
description:
- Display output using a specific parameter. Use 'all' to display possible
output. List of comma separated parameters.
- Display output using a specific parameter. Use 'all' to display
possible output. List of comma separated parameters.
default: 'all'
pn_options:
description:
- Specify formatting options.

View file

@ -19,7 +19,7 @@
#
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'status': ['deprecated'],
'supported_by': 'community'}
@ -29,6 +29,10 @@ module: pn_trunk
author: "Pluribus Networks (@amitsi)"
version_added: "2.2"
short_description: CLI command to create/delete/modify a trunk.
deprecated:
removed_in: '2.12'
why: Doesn't support latest Pluribus Networks netvisor
alternative: Latest modules will be pushed in Ansible future versions.
description:
- Execute trunk-create or trunk-delete command.
- Trunks can be used to aggregate network links at Layer 2 on the local
@ -46,6 +50,7 @@ options:
description:
- Target switch(es) to run the cli on.
required: False
default: 'local'
state:
description:
- State the action to perform. Use 'present' to create trunk,
@ -70,6 +75,7 @@ options:
pn_jumbo:
description:
- Specify if the port can receive jumbo frames.
type: bool
pn_lacp_mode:
description:
- Specify the LACP mode for the configuration.
@ -94,18 +100,22 @@ options:
pn_edge_switch:
description:
- Specify if the switch is an edge switch.
type: bool
pn_pause:
description:
- Specify if pause frames are sent.
type: bool
pn_description:
description:
- Specify a description for the trunk configuration.
pn_loopback:
description:
- Specify loopback if you want to use loopback.
type: bool
pn_mirror_receive:
description:
- Specify if the configuration receives mirrored traffic.
type: bool
pn_unknown_ucast_level:
description:
- Specify an unknown unicast level in percent. The default value is 100%.
@ -124,9 +134,11 @@ options:
pn_routing:
description:
- Specify if the port participates in routing on the network.
type: bool
pn_host:
description:
- Host facing port control setting.
type: bool
"""
EXAMPLES = """
@ -294,7 +306,7 @@ def main():
pn_lacp_mode=dict(type='str', choices=[
'off', 'passive', 'active']),
pn_lacp_priority=dict(type='int'),
pn_lacp_timeout=dict(type='str'),
pn_lacp_timeout=dict(type='str', choices=['slow', 'fast']),
pn_lacp_fallback=dict(type='str', choices=[
'bundle', 'individual']),
pn_lacp_fallback_timeout=dict(type='str'),

View file

@ -19,7 +19,7 @@
#
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'status': ['deprecated'],
'supported_by': 'community'}
@ -29,6 +29,10 @@ module: pn_vlag
author: "Pluribus Networks (@amitsi)"
version_added: "2.2"
short_description: CLI command to create/delete/modify vlag.
deprecated:
removed_in: '2.12'
why: Doesn't support latest Pluribus Networks netvisor
alternative: Latest modules will be pushed in Ansible future versions.
description:
- Execute vlag-create/vlag-delete/vlag-modify command.
- A virtual link aggregation group (VLAG) allows links that are physically
@ -49,6 +53,7 @@ options:
pn_cliswitch:
description:
- Target switch(es) to run this command on.
default: 'local'
state:
description:
- State the action to perform. Use 'present' to create vlag,
@ -267,7 +272,7 @@ def main():
'off', 'passive', 'active']),
pn_lacp_timeout=dict(type='str', choices=['slow', 'fast']),
pn_lacp_fallback=dict(type='str', choices=[
'individual', 'bundled']),
'bundle', 'individual']),
pn_lacp_fallback_timeout=dict(type='str')
),
required_if=(

View file

@ -19,7 +19,7 @@
#
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'status': ['deprecated'],
'supported_by': 'community'}
@ -29,6 +29,10 @@ module: pn_vlan
author: "Pluribus Networks (@amitsi)"
version_added: "2.2"
short_description: CLI command to create/delete a VLAN.
deprecated:
removed_in: '2.12'
why: Doesn't support latest Pluribus Networks netvisor
alternative: Latest modules will be pushed in Ansible future versions.
description:
- Execute vlan-create or vlan-delete command.
- VLANs are used to isolate network traffic at Layer 2.The VLAN identifiers
@ -47,6 +51,7 @@ options:
description:
- Target switch(es) to run the cli on.
required: False
default: 'local'
state:
description:
- State the action to perform. Use 'present' to create vlan and

View file

@ -19,7 +19,7 @@
#
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'status': ['deprecated'],
'supported_by': 'community'}
@ -29,6 +29,10 @@ module: pn_vrouter
author: "Pluribus Networks (@amitsi)"
version_added: "2.2"
short_description: CLI command to create/delete/modify a vrouter.
deprecated:
removed_in: '2.12'
why: Doesn't support latest Pluribus Networks netvisor
alternative: Latest modules will be pushed in Ansible future versions.
description:
- Execute vrouter-create, vrouter-delete, vrouter-modify command.
- Each fabric, cluster, standalone switch, or virtual network (VNET) can
@ -50,6 +54,7 @@ options:
description:
- Target switch(es) to run the CLI on.
required: False
default: 'local'
state:
description:
- State the action to perform. Use 'present' to create vrouter,
@ -112,6 +117,9 @@ options:
description:
- Specify other OSPF options as a whitespaces separated string within
single quotes ''.
pn_vrrp_track_port:
description:
- Specify list of ports and port ranges.
"""
EXAMPLES = """

View file

@ -19,7 +19,7 @@
#
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'status': ['deprecated'],
'supported_by': 'community'}
@ -29,6 +29,10 @@ module: pn_vrouterbgp
author: "Pluribus Networks (@amitsi)"
version_added: "2.2"
short_description: CLI command to add/remove/modify vrouter-bgp.
deprecated:
removed_in: '2.12'
why: Doesn't support latest Pluribus Networks netvisor
alternative: Latest modules will be pushed in Ansible future versions.
description:
- Execute vrouter-bgp-add, vrouter-bgp-remove, vrouter-bgp-modify command.
- Each fabric, cluster, standalone switch, or virtual network (VNET) can
@ -47,6 +51,7 @@ options:
description:
- Target switch(es) to run the cli on.
required: False
default: 'local'
state:
description:
- State the action to perform. Use 'present' to add bgp,

View file

@ -19,7 +19,7 @@
#
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'status': ['deprecated'],
'supported_by': 'community'}
@ -29,6 +29,10 @@ module: pn_vrouterif
author: "Pluribus Networks (@amitsi)"
version_added: "2.2"
short_description: CLI command to add/remove/modify vrouter-interface.
deprecated:
removed_in: '2.12'
why: Doesn't support latest Pluribus Networks netvisor
alternative: Latest modules will be pushed in Ansible future versions.
description:
- Execute vrouter-interface-add, vrouter-interface-remove,
vrouter-interface-modify command.
@ -47,6 +51,7 @@ options:
description:
- Target switch to run the cli on.
required: False
default: 'local'
state:
description:
- State the action to perform. Use 'present' to add vrouter interface,
@ -85,6 +90,7 @@ options:
specified when you configure the interface as span interface and allows
higher throughput through the interface.
type: bool
required: False
pn_nic_enable:
description:
- Specify if the NIC is enabled or not
@ -353,7 +359,7 @@ def main():
pn_clipassword=dict(required=False, type='str', no_log=True),
pn_cliswitch=dict(required=False, type='str', default='local'),
state=dict(required=True, type='str',
choices=['present', 'absent']),
choices=['present', 'absent', 'update']),
pn_vrouter_name=dict(required=True, type='str'),
pn_vlan=dict(type='int'),
pn_interface_ip=dict(required=True, type='str'),

View file

@ -19,7 +19,7 @@
#
ANSIBLE_METADATA = {'metadata_version': '1.1',
'status': ['preview'],
'status': ['deprecated'],
'supported_by': 'community'}
@ -29,6 +29,10 @@ module: pn_vrouterlbif
author: "Pluribus Networks (@amitsi)"
version_added: "2.2"
short_description: CLI command to add/remove vrouter-loopback-interface.
deprecated:
removed_in: '2.12'
why: Doesn't support latest Pluribus Networks netvisor
alternative: Latest modules will be pushed in Ansible future versions.
description:
- Execute vrouter-loopback-interface-add, vrouter-loopback-interface-remove
commands.
@ -48,6 +52,7 @@ options:
description:
- Target switch(es) to run the cli on.
required: False
default: 'local'
state:
description:
- State the action to perform. Use 'present' to add vrouter loopback