Add 'Tested on' string to NX-OS modules (#28531)
This commit is contained in:
parent
d830186e27
commit
ada7f248c0
50 changed files with 50 additions and 0 deletions
|
@ -32,6 +32,7 @@ description:
|
|||
author:
|
||||
- Jason Edelman (@jedelman8)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- Either C(sysmtu) param is required or (C(interface) AND C(mtu)) parameters are required.
|
||||
- C(state=absent) unconfigures a given MTU if that value is currently present.
|
||||
options:
|
||||
|
|
|
@ -33,6 +33,7 @@ description:
|
|||
author:
|
||||
- Jason Edelman (@jedelman8)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- The server_type parameter is always required.
|
||||
- If encrypt_type is not supplied, the global AAA server key will be
|
||||
stored as encrypted (type 7).
|
||||
|
|
|
@ -32,6 +32,7 @@ description:
|
|||
- Manages AAA server host-specific configuration.
|
||||
author: Jason Edelman (@jedelman8)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- Changes to the AAA server host key (shared secret) are not idempotent.
|
||||
- If C(state=absent) removes the whole host configuration.
|
||||
options:
|
||||
|
|
|
@ -33,6 +33,7 @@ author:
|
|||
- Jason Edelman (@jedelman8)
|
||||
- Gabriele Gerbino (@GGabriele)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- C(state=absent) removes the ACE if it exists.
|
||||
- C(state=delete_acl) deletes the ACL if it exists.
|
||||
- For idempotency, use port numbers for the src/dest port
|
||||
|
|
|
@ -33,6 +33,7 @@ author:
|
|||
- Jason Edelman (@jedelman8)
|
||||
- Gabriele Gerbino (@GGabriele)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- C(state=absent) removes the whole BGP ASN configuration when
|
||||
C(vrf=default) or the whole VRF instance within the BGP process when
|
||||
using a different VRF.
|
||||
|
|
|
@ -31,6 +31,7 @@ description:
|
|||
- Manages BGP Address-family configurations on NX-OS switches.
|
||||
author: Gabriele Gerbino (@GGabriele)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- C(state=absent) removes the whole BGP ASN configuration
|
||||
- Default, where supported, restores params default value.
|
||||
options:
|
||||
|
|
|
@ -31,6 +31,7 @@ description:
|
|||
- Manages BGP neighbors configurations on NX-OS switches.
|
||||
author: Gabriele Gerbino (@GGabriele)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- C(state=absent) removes the whole BGP neighbor configuration.
|
||||
- Default, where supported, restores params default value.
|
||||
options:
|
||||
|
|
|
@ -31,6 +31,7 @@ description:
|
|||
- Manages BGP address-family's neighbors configurations on NX-OS switches.
|
||||
author: Gabriele Gerbino (@GGabriele)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- C(state=absent) removes the whole BGP address-family's
|
||||
neighbor configuration.
|
||||
- Default, when supported, removes properties
|
||||
|
|
|
@ -32,6 +32,7 @@ description:
|
|||
Identifier (VNI) configurations of a Nexus device.
|
||||
author: Gabriele Gerbino (@GGabriele)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- default, where supported, restores params default value.
|
||||
- RD override is not permitted. You should set it to the default values
|
||||
first and then reconfigure it.
|
||||
|
|
|
@ -33,6 +33,7 @@ author:
|
|||
- Jason Edelman (@jedelman8)
|
||||
- Gabriele Gerbino (@GGabriele)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- The feature must be enabled with feature scp-server.
|
||||
- If the file is already present (md5 sums match), no transfer will
|
||||
take place.
|
||||
|
|
|
@ -32,6 +32,7 @@ description:
|
|||
author:
|
||||
- Gabriele Gerbino (@GGabriele)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- C(state) has effect only in combination with
|
||||
C(system_mode_maintenance_timeout) or
|
||||
C(system_mode_maintenance_on_reload_reset_reason).
|
||||
|
|
|
@ -34,6 +34,7 @@ description:
|
|||
author:
|
||||
- Gabriele Gerbino (@GGabriele)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- This module is not idempotent when C(state=present).
|
||||
- C(state=absent) removes the whole profile.
|
||||
options:
|
||||
|
|
|
@ -33,6 +33,7 @@ author:
|
|||
- Jason Edelman (@jedelman8)
|
||||
- Gabriele Gerbino (@GGabriele)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- HSRP feature needs to be enabled first on the system.
|
||||
- SVIs must exist before using this module.
|
||||
- Interface must be a L3 port before using this module.
|
||||
|
|
|
@ -33,6 +33,7 @@ author:
|
|||
- Jason Edelman (@jedelman8)
|
||||
- Gabriele Gerbino (@GGabriele)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- When C(state=default), all supported params will be reset to a
|
||||
default state.
|
||||
- If restart is set to true with other params set, the restart will happen
|
||||
|
|
|
@ -33,6 +33,7 @@ author:
|
|||
- Jason Edelman (@jedelman8)
|
||||
- Gabriele Gerbino (@GGabriele)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- When C(state=default), supported params will be reset to a default state.
|
||||
These include C(version), C(startup_query_interval),
|
||||
C(startup_query_count), C(robustness), C(querier_timeout), C(query_mrt),
|
||||
|
|
|
@ -33,6 +33,7 @@ author:
|
|||
- Jason Edelman (@jedelman8)
|
||||
- Gabriele Gerbino (@GGabriele)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- When C(state=default), params will be reset to a default state.
|
||||
- C(group_timeout) also accepts I(never) as an input.
|
||||
options:
|
||||
|
|
|
@ -30,6 +30,7 @@ description:
|
|||
- Install an operating system by setting the boot options like boot
|
||||
image and kickstart image.
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- The module will fail due to timeout issues, but the install will go on
|
||||
anyway. Ansible's block and rescue can be leveraged to handle this kind
|
||||
of failure and check actual module results. See EXAMPLE for more about
|
||||
|
|
|
@ -31,6 +31,7 @@ description:
|
|||
- Manages physical attributes of interfaces of NX-OS switches.
|
||||
author: Jason Edelman (@jedelman8)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- This module is also used to create logical interfaces such as
|
||||
svis and loopbacks.
|
||||
- Be cautious of platform specific idiosyncrasies. For example,
|
||||
|
|
|
@ -31,6 +31,7 @@ description:
|
|||
- Manages configuration of an OSPF interface instance.
|
||||
author: Gabriele Gerbino (@GGabriele)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- Default, where supported, restores params default value.
|
||||
- To remove an existing authentication configuration you should use
|
||||
C(message_digest_key_id=default) plus all other options matching their
|
||||
|
|
|
@ -32,6 +32,7 @@ author:
|
|||
- Jason Edelman (@jedelman8)
|
||||
- Gabriele Gerbino (@GGabriele)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- Interface must already be a L3 port when using this module.
|
||||
- Logical interfaces (po, loop, svi) must be created first.
|
||||
- C(mask) must be inserted in decimal format (i.e. 24) for
|
||||
|
|
|
@ -33,6 +33,7 @@ description:
|
|||
author:
|
||||
- Jason Edelman (@jedelman8)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- If C(state=absent), the module will attempt to remove the given key configuration.
|
||||
If a matching key configuration isn't found on the device, the module will fail.
|
||||
- If C(state=absent) and C(authentication=on), authentication will be turned off.
|
||||
|
|
|
@ -33,6 +33,7 @@ description:
|
|||
author:
|
||||
- Jason Edelman (@jedelman8)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- At least one of C(master) or C(logging) params must be supplied.
|
||||
- When C(state=absent), boolean parameters are flipped,
|
||||
e.g. C(master=true) will disable the authoritative server.
|
||||
|
|
|
@ -30,6 +30,7 @@ description:
|
|||
- Manages a VRF for an OSPF router.
|
||||
author: Gabriele Gerbino (@GGabriele)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- Value I(default) restores params default value, if any.
|
||||
Otherwise it removes the existing param configuration.
|
||||
options:
|
||||
|
|
|
@ -30,6 +30,7 @@ description:
|
|||
- Configures anycast gateway MAC of the switch.
|
||||
author: Gabriele Gerbino (@GGabriele)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- Default restores params default value
|
||||
- Supported MAC address format are "E.E.E", "EE-EE-EE-EE-EE-EE",
|
||||
"EE:EE:EE:EE:EE:EE" and "EEEE.EEEE.EEEE"
|
||||
|
|
|
@ -32,6 +32,7 @@ description:
|
|||
author:
|
||||
- Jason Edelman (@jedelman8)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- When C(state=default), supported params will be reset to a default state.
|
||||
These include C(dr_prio), C(hello_auth_key), C(hello_interval), C(jp_policy_out),
|
||||
C(jp_policy_in), C(jp_type_in), C(jp_type_out), C(border), C(neighbor_policy),
|
||||
|
|
|
@ -32,6 +32,7 @@ description:
|
|||
rendezvous point (RP) address instance.
|
||||
author: Gabriele Gerbino (@GGabriele)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- C(state=absent) remove the whole rp-address configuration, if existing.
|
||||
options:
|
||||
rp_address:
|
||||
|
|
|
@ -32,6 +32,7 @@ author:
|
|||
- Jason Edelman (@jedelman8)
|
||||
- Gabriele Gerbino (@GGabriele)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- C(state=absent) removes the portchannel config and interface if it
|
||||
already exists. If members to be removed are not explicitly
|
||||
passed, all existing members (if any), are removed.
|
||||
|
|
|
@ -33,6 +33,7 @@ author:
|
|||
- Jason Edelman (@jedelman8)
|
||||
- Gabriele Gerbino (@GGabriele)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- The module will fail due to timeout issues, but the reboot will be
|
||||
performed anyway.
|
||||
options:
|
||||
|
|
|
@ -35,6 +35,7 @@ author:
|
|||
- Jason Edelman (@jedelman8)
|
||||
- Gabriele Gerbino (@GGabriele)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- Sometimes C(transport=nxapi) may cause a timeout error.
|
||||
options:
|
||||
checkpoint_file:
|
||||
|
|
|
@ -31,6 +31,7 @@ description:
|
|||
- Perform software maintenance upgrades (SMUs) on Cisco NX-OS devices.
|
||||
author: Gabriele Gerbino (@GGabriele)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- The module can only activate and commit a package,
|
||||
not remove or deactivate it.
|
||||
- Use C(transport=nxapi) to avoid connection timeout
|
||||
|
|
|
@ -34,6 +34,7 @@ description:
|
|||
author:
|
||||
- Gabriele Gerbino (@GGabriele)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- C(transport=cli) may cause timeout errors.
|
||||
- The C(element_key1) and C(element_key2) parameter specify the tags used
|
||||
to distinguish among row entries. In most cases, only the element_key1
|
||||
|
|
|
@ -33,6 +33,7 @@ author:
|
|||
- Jason Edelman (@jedelman8)
|
||||
- Gabriele Gerbino (@GGabriele)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- C(state=absent) removes the contact configuration if it is configured.
|
||||
options:
|
||||
contact:
|
||||
|
|
|
@ -34,6 +34,7 @@ author:
|
|||
- Jason Edelman (@jedelman8)
|
||||
- Gabriele Gerbino (@GGabriele)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- C(state=absent) removes the host configuration if it is configured.
|
||||
options:
|
||||
snmp_host:
|
||||
|
|
|
@ -33,6 +33,7 @@ description:
|
|||
author:
|
||||
- Jason Edelman (@jedelman8)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- This module works at the group level for traps. If you need to only
|
||||
enable/disable 1 specific trap within a group, use the M(nxos_command)
|
||||
module.
|
||||
|
|
|
@ -32,6 +32,7 @@ description:
|
|||
author:
|
||||
- Jason Edelman (@jedelman8)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- Authentication parameters not idempotent.
|
||||
options:
|
||||
user:
|
||||
|
|
|
@ -30,6 +30,7 @@ description:
|
|||
- Manages static route configuration
|
||||
author: Gabriele Gerbino (@GGabriele)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- If no vrf is supplied, vrf is set to default.
|
||||
- If C(state=absent), the route will be removed, regardless of the
|
||||
non-required parameters.
|
||||
|
|
|
@ -30,6 +30,7 @@ description:
|
|||
- Manages Layer 2 interfaces
|
||||
author: Jason Edelman (@jedelman8)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- When C(state=absent), VLANs can be added/removed from trunk links and
|
||||
the existing access VLAN can be 'unconfigured' to just having VLAN 1
|
||||
on that interface.
|
||||
|
|
|
@ -33,6 +33,7 @@ description:
|
|||
author:
|
||||
- Jason Edelman (@jedelman8)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- When C(state=absent), it unconfigures existing settings C(msg_time) and set it
|
||||
to its default value of 15. It is cleaner to always use C(state=present).
|
||||
- Module will fail if the udld feature has not been previously enabled.
|
||||
|
|
|
@ -32,6 +32,7 @@ description:
|
|||
author:
|
||||
- Jason Edelman (@jedelman8)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- Feature UDLD must be enabled on the device to use this module.
|
||||
options:
|
||||
mode:
|
||||
|
|
|
@ -33,6 +33,7 @@ author:
|
|||
- Jason Edelman (@jedelman8)
|
||||
- Gabriele Gerbino (@GGabriele)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- The feature vpc must be enabled before this module can be used
|
||||
- If not using management vrf, vrf must be globally on the device
|
||||
before using in the pkl config
|
||||
|
|
|
@ -32,6 +32,7 @@ author:
|
|||
- Jason Edelman (@jedelman8)
|
||||
- Gabriele Gerbino (@GGabriele)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- Either vpc or peer_link param is required, but not both.
|
||||
- C(state=absent) removes whatever VPC config is on a port-channel
|
||||
if one exists.
|
||||
|
|
|
@ -33,6 +33,7 @@ author:
|
|||
- Jason Edelman (@jedelman8)
|
||||
- Gabriele Gerbino (@GGabriele)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- Cisco NX-OS creates the default VRF by itself. Therefore,
|
||||
you're not allowed to use default as I(vrf) name in this module.
|
||||
- C(vrf) name must be shorter than 32 chars.
|
||||
|
|
|
@ -30,6 +30,7 @@ description:
|
|||
- Manages VRF AF
|
||||
author: Gabriele Gerbino (@GGabriele)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- Default, where supported, restores params default value.
|
||||
options:
|
||||
vrf:
|
||||
|
|
|
@ -33,6 +33,7 @@ author:
|
|||
- Jason Edelman (@jedelman8)
|
||||
- Gabriele Gerbino (@GGabriele)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- VRF needs to be added globally with M(nxos_vrf) before
|
||||
adding a VRF to an interface.
|
||||
- Remove a VRF from an interface will still remove
|
||||
|
|
|
@ -34,6 +34,7 @@ author:
|
|||
- Jason Edelman (@jedelman8)
|
||||
- Gabriele Gerbino (@GGabriele)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- VRRP feature needs to be enabled first on the system.
|
||||
- SVIs must exist before using this module.
|
||||
- Interface must be a L3 port before using this module.
|
||||
|
|
|
@ -31,6 +31,7 @@ description:
|
|||
author:
|
||||
- Gabriele Gerbino (@GGabriele)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- VTP feature must be active on the device to use this module.
|
||||
- This module is used to manage only VTP domain names.
|
||||
- VTP domain names are case-sensible.
|
||||
|
|
|
@ -33,6 +33,7 @@ description:
|
|||
author:
|
||||
- Gabriele Gerbino (@GGabriele)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- VTP feature must be active on the device to use this module.
|
||||
- This module is used to manage only VTP passwords.
|
||||
- Use this in combination with M(nxos_vtp_domain) and M(nxos_vtp_version)
|
||||
|
|
|
@ -33,6 +33,7 @@ description:
|
|||
author:
|
||||
- Gabriele Gerbino (@GGabriele)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- VTP feature must be active on the device to use this module.
|
||||
- This module is used to manage only VTP version.
|
||||
- Use this in combination with M(nxos_vtp_password) and M(nxos_vtp_version)
|
||||
|
|
|
@ -32,6 +32,7 @@ description:
|
|||
that terminates VXLAN tunnels.
|
||||
author: Gabriele Gerbino (@GGabriele)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- The module is used to manage NVE properties, not to create NVE
|
||||
interfaces. Use M(nxos_interface) if you wish to do so.
|
||||
- C(state=absent) removes the interface.
|
||||
|
|
|
@ -32,6 +32,7 @@ description:
|
|||
overlay interface.
|
||||
author: Gabriele Gerbino (@GGabriele)
|
||||
notes:
|
||||
- Tested against NXOSv 7.3.(0)D1(1) on VIRL
|
||||
- default, where supported, restores params default value.
|
||||
options:
|
||||
interface:
|
||||
|
|
Loading…
Reference in a new issue