ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

[WIP] Network return docs (#23441)

Browse source 
Network return docs
This commit is contained in:
John R Barker 2017-04-12 13:13:41 -04:00 committed by GitHub
parent 92dc61e869
commit 902bc58509
79 changed files with 184 additions and 172 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
lib/ansible/modules/network/asa/asa_acl.py
View file

@ -143,7 +143,7 @@ updates:
responses:
description: The set of responses from issuing the commands on the device
retured: when not check_mode
returned: when not check_mode
type: list
sample: ['...', '...']
"""

2
lib/ansible/modules/network/asa/asa_command.py
View file

@ -129,7 +129,7 @@ stdout_lines:
failed_conditions:
description: the conditionals that failed
retured: failed
returned: failed
type: list
sample: ['...', '...']
"""

16
lib/ansible/modules/network/bigswitch/bigmon_chain.py
View file

@ -69,21 +69,7 @@ EXAMPLES = '''
'''
RETURN = '''
{
"changed": true,
"invocation": {
"module_args": {
"access_token": null,
"controller": "192.168.86.221",
"name": "MyChain",
"state": "present",
"validate_certs": false
},
"module_name": "bigmon_chain"
}
}
'''
RETURN = ''' # '''
import os
from ansible.module_utils.basic import AnsibleModule

22
lib/ansible/modules/network/bigswitch/bigmon_policy.py
View file

@ -95,27 +95,7 @@ EXAMPLES = '''
validate_certs: false
'''
RETURN = '''
{
"changed": false,
"invocation": {
"module_args": {
"access_token": null,
"action": "drop",
"controller": "192.168.86.221",
"delivery_packet_count": 0,
"duration": 0,
"name": "policy1",
"policy_description": "DC 1 traffic policy",
"priority": 100,
"start_time": "2017-01-13T23:10:41.978584+00:00",
"state": "present",
"validate_certs": false
},
"module_name": "bigmon_policy"
}
}
'''
RETURN = ''' # '''
import os
import datetime

2
lib/ansible/modules/network/cloudflare_dns.py
View file

@ -193,7 +193,7 @@ RETURN = '''
record:
description: dictionary containing the record data
returned: success, except on record deletion
type: dictionary
type: complex
contains:
content:
description: the record content (details depend on record type)

1
lib/ansible/modules/network/eos/eos_facts.py
View file

@ -77,6 +77,7 @@ ansible_net_model:
ansible_net_serialnum:
description: The serial number of the remote device
returned: always
type: str
ansible_net_version:
description: The operating system version running on the remote device
returned: always

2
lib/ansible/modules/network/exoscale/exo_dns_domain.py
View file

@ -101,7 +101,7 @@ RETURN = '''
exo_dns_domain:
description: API domain results
returned: success
type: dictionary
type: complex
contains:
account_id:
description: Your account ID

2
lib/ansible/modules/network/exoscale/exo_dns_record.py
View file

@ -181,7 +181,7 @@ RETURN = '''
exo_dns_record:
description: API record results
returned: success
type: dictionary
type: complex
contains:
content:
description: value of the record

6
lib/ansible/modules/network/f5/bigip_device_sshd.py
View file

@ -145,7 +145,7 @@ banner_text:
inactivity_timeout:
description: >
The number of seconds before inactivity causes an SSH.
session to log out
session to log out.
returned: changed
type: int
sample: "10"
@ -156,12 +156,12 @@ log_level:
sample: "debug"
login:
description: Specifies that the system accepts SSH communications or not.
return: changed
returned: changed
type: bool
sample: true
port:
description: Port that you want the SSH daemon to run on.
return: changed
returned: changed
type: int
sample: 22
'''

2
lib/ansible/modules/network/f5/bigip_routedomain.py
View file

@ -160,7 +160,7 @@ bwc_policy:
connection_limit:
description: The new connection limit for the route domain
returned: changed
type: integer
type: int
sample: 100
flow_eviction_policy:
description: The new eviction policy to use with this route domain

17
lib/ansible/modules/network/f5/bigip_selfip.py
View file

@ -201,31 +201,22 @@ address:
sample: "192.0.2.10"
name:
description: The name of the Self IP
returned:
- created
- changed
- deleted
returned: created, changed or deleted
type: string
sample: "self1"
netmask:
description: The netmask of the Self IP
returned:
- changed
- created
returned: created or changed
type: string
sample: "255.255.255.0"
traffic_group:
description: The traffic group that the Self IP is a member of
return:
- changed
- created
returned: changed or created
type: string
sample: "traffic-group-local-only"
vlan:
description: The VLAN set on the Self IP
return:
- changed
- created
returned: created or changed
type: string
sample: "vlan1"
'''

23
lib/ansible/modules/network/f5/bigip_ssl_certificate.py
View file

@ -138,42 +138,29 @@ cert_name:
description: >
The name of the SSL certificate. The C(cert_name) and
C(key_name) will be equal to each other.
returned:
- created
- changed
- deleted
returned: created, changed or deleted
type: string
sample: "cert1"
key_name:
description: >
The name of the SSL certificate key. The C(key_name) and
C(cert_name) will be equal to each other.
returned:
- created
- changed
- deleted
returned: created, changed or deleted
type: string
sample: "key1"
partition:
description: Partition in which the cert/key was created
returned:
- changed
- created
- deleted
returned: created, changed or deleted
type: string
sample: "Common"
key_checksum:
description: SHA1 checksum of the key that was provided
return:
- changed
- created
returned: created or changed
type: string
sample: "cf23df2207d99a74fbe169e3eba035e633b65d94"
cert_checksum:
description: SHA1 checksum of the cert that was provided
return:
- changed
- created
returned: created or changed
type: string
sample: "f7ff9e8b7bb2e09b70935a5d785e0cc5d9d0abf0"
'''

2
lib/ansible/modules/network/f5/bigip_sys_global.py
View file

@ -121,7 +121,7 @@ console_timeout:
The new number of seconds of inactivity before the system
logs off a user that is logged on.
returned: changed
type: integer
type: int
sample: 600
gui_setup:
description: The new setting for the Setup utility.

2
lib/ansible/modules/network/illumos/ipadm_prop.py
View file

@ -93,7 +93,7 @@ value:
description: value of the property
returned: always
type: int/string (depends on property)
sample: 1024/never
sample: "'1024' or 'never'"
'''
SUPPORTED_PROTOCOLS = ['ipv4', 'ipv6', 'icmp', 'tcp', 'udp', 'sctp']

2
lib/ansible/modules/network/ipinfoio_facts.py
View file

@ -55,7 +55,7 @@ RETURN = '''
ansible_facts:
description: "Dictionary of ip geolocation facts for a host's IP address"
returned: changed
type: dictionary
type: complex
contains:
ip:
description: "Public IP address of a host"

9
lib/ansible/modules/network/junos/junos_rpc.py
View file

@ -72,14 +72,17 @@ EXAMPLES = """
RETURN = """
xml:
description: The xml return string from the rpc request
description: The xml return string from the rpc request.
returned: always
type: string
output:
description: The rpc rely converted to the output format
description: The rpc rely converted to the output format.
returned: always
type: string
output_lines:
description: The text output split into lines for readability
description: The text output split into lines for readability.
returned: always
type: list
"""
from ncclient.xml_ import new_ele, sub_ele, to_xml, to_ele

10
lib/ansible/modules/network/lenovo/cnos_backup.py
View file

@ -160,11 +160,11 @@ Tasks : The following are examples of using the module cnos_backup. These are wr
'''
RETURN = '''
---
return value: |
On successful execution, the method returns a message in JSON format
[Config file tranferred to server]
Upon any failure, the method returns an error display string.
msg:
description: Success or failure message
returned: always
type: string
sample: "Config file tranferred to server"
'''
import sys

8
lib/ansible/modules/network/lenovo/cnos_bgp.py
View file

@ -358,10 +358,10 @@ Tasks: The following are examples of using the module cnos_bgp. These are writte
'''
RETURN = '''
return value: |
On successful execution, the method returns an empty string with the following message in JSON format.
[BGP configurations accomplished]
Upon any failure, the method returns an error display string. The error must be corrected before attempting the method again.
msg:
description: Success or failure message. Upon any failure, the method returns an error display string.
returned: always
type: string
'''
import sys

9
lib/ansible/modules/network/lenovo/cnos_command.py
View file

@ -69,10 +69,11 @@ Tasks : The following are examples of using the module cnos_command. These are w
'''
RETURN = '''
return value: |
On successful execution, the method returns a message in JSON format
[Command Applied]
Upon any failure, the method returns an error display string.
msg:
description: Success or failure message
returned: always
type: string
sample: "Command Applied"
'''

10
lib/ansible/modules/network/lenovo/cnos_conditional_command.py
View file

@ -89,11 +89,11 @@ Tasks : The following are examples of using the module cnos_conditional_command.
'''
RETURN = '''
return value: |
On successful execution, the method returns a message in JSON format
[Command Applied]
Upon any failure, the method returns an error display string.
msg:
description: Success or failure message
returned: always
type: string
sample: "Command Applied"
'''
import sys

10
lib/ansible/modules/network/lenovo/cnos_conditional_template.py
View file

@ -96,11 +96,11 @@ Tasks : The following are examples of using the module cnos_conditional_template
switchport_mode1: trunk
'''
RETURN = '''
return value: |
On successful execution, the method returns a message in JSON format
[Template Applied.]
Upon any failure, the method returns an error display string.
msg:
description: Success or failure message
returned: always
type: string
sample: "Template Applied."
'''
import sys

10
lib/ansible/modules/network/lenovo/cnos_factory.py
View file

@ -58,11 +58,11 @@ Tasks : The following are examples of using the module cnos_reload. These are wr
'''
RETURN = '''
return value: |
On successful execution, the method returns a message in JSON format
[Switch Startup Config is Reset to factory settings]
Upon any failure, the method returns an error display string.
msg:
description: Success or failure message
returned: always
type: string
sample: "Switch Startup Config is Reset to factory settings"
'''

10
lib/ansible/modules/network/lenovo/cnos_facts.py
View file

@ -56,13 +56,13 @@ Tasks : The following are examples of using the module cnos_facts. These are wri
outputfile: "./results/cnos_facts_{{ inventory_hostname }}_output.txt"
'''
RETURN = '''
return value: |
On successful execution, the method returns a message in JSON format
[Device Sys Info is saved to file]
Upon any failure, the method returns an error display string.
msg:
description: Success or failure message
returned: always
type: string
sample: "Device Sys Info is saved to file"
'''
import sys
import paramiko
import time

10
lib/ansible/modules/network/lenovo/cnos_image.py
View file

@ -117,11 +117,13 @@ Tasks : The following are examples of using the module cnos_image. These are wri
serverpassword: "root123"
'''
RETURN = '''
return value: |
On successful execution, the method returns a message in JSON format
[Image file tranferred to device]
Upon any failure, the method returns an error display string.
msg:
description: Success or failure message
returned: always
type: string
sample: "Image file tranferred to device"
'''
import sys
import paramiko
import time

10
lib/ansible/modules/network/lenovo/cnos_interface.py
View file

@ -455,11 +455,11 @@ Tasks : The following are examples of using the module cnos_interface. These are
'''
RETURN = '''
return value: |
On successful execution, the method returns a message in JSON format
[Interface configurations accomplished.]
Upon any failure, the method returns an error display string.
msg:
description: Success or failure message
returned: always
type: string
sample: "Interface configurations accomplished."
'''
import sys

10
lib/ansible/modules/network/lenovo/cnos_portchannel.py
View file

@ -407,13 +407,13 @@ Tasks : The following are examples of using the module cnos_portchannel. These a
'''
RETURN = '''
return value: |
On successful execution, the method returns a message in JSON format
[Port Channel configurations accomplished]
Upon any failure, the method returns an error display string.
msg:
description: Success or failure message
returned: always
type: string
sample: "Port Channel configurations accomplished"
'''
import sys
import paramiko
import time

11
lib/ansible/modules/network/lenovo/cnos_reload.py
View file

@ -57,14 +57,13 @@ Tasks : The following are examples of using the module cnos_reload. These are wr
outputfile: "./results/test_reload_{{ inventory_hostname }}_output.txt"
'''
RETURN = '''
return value: |
On successful execution, the method returns a message in JSON format
[Device is Reloading. Please wait...]
Upon any failure, the method returns an error display string.
msg:
description: Success or failure message
returned: always
type: string
sample: "Device is Reloading. Please wait..."
'''
import sys
import paramiko
import time

10
lib/ansible/modules/network/lenovo/cnos_rollback.py
View file

@ -153,11 +153,13 @@ Tasks : The following are examples of using the module cnos_rollback. These are
'''
RETURN = '''
return value: |
On successful execution, the method returns a message in JSON format
[Config file tranferred to Device]
Upon any failure, the method returns an error display string.
msg:
description: Success or failure message
returned: always
type: string
sample: "Config file tranferred to Device"
'''
import sys
import paramiko
import time

9
lib/ansible/modules/network/lenovo/cnos_save.py
View file

@ -58,10 +58,11 @@ Tasks : The following are examples of using the module cnos_save. These are writ
outputfile: "./results/test_save_{{ inventory_hostname }}_output.txt"
'''
RETURN = '''
return value: |
On successful execution, the method returns a message in JSON format
[Switch Running Config is Saved to Startup Config]
Upon any failure, the method returns an error display string.
msg:
description: Success or failure message
returned: always
type: string
sample: "Switch Running Config is Saved to Startup Config"
'''
import sys

11
lib/ansible/modules/network/lenovo/cnos_showrun.py
View file

@ -59,12 +59,13 @@ Tasks : The following are examples of using the module cnos_showrun. These are w
'''
RETURN = '''
return value: |
On successful execution, the method returns a message in JSON format
[Running Configuration saved in file]
Upon any failure, the method returns an error display string.
msg:
description: Success or failure message
returned: always
type: string
sample: "Running Configuration saved in file"
'''
import sys
import paramiko
import time

10
lib/ansible/modules/network/lenovo/cnos_template.py
View file

@ -81,11 +81,13 @@ Tasks : The following are examples of using the module cnos_template. These are
'''
RETURN = '''
return value: |
On successful execution, the method returns a message in JSON format
[Template Applied.]
Upon any failure, the method returns an error display string.
msg:
description: Success or failure message
returned: always
type: string
sample: "Template Applied."
'''
import sys
import paramiko
import time

9
lib/ansible/modules/network/lenovo/cnos_vlag.py
View file

@ -242,10 +242,11 @@ Tasks : The following are examples of using the module cnos_vlag. These are writ
'''
RETURN = '''
return value: |
On successful execution, the method returns a message in JSON format
[vLAG configurations accomplished]
Upon any failure, the method returns an error display string.
msg:
description: Success or failure message
returned: always
type: string
sample: "vLAG configurations accomplished"
'''
import sys

9
lib/ansible/modules/network/lenovo/cnos_vlan.py
View file

@ -181,10 +181,11 @@ Tasks: The following are examples of using the module cnos_vlan. These are writt
'''
RETURN = '''
return value: |
On successful execution, the method returns a message in JSON format
[VLAN configurations are successful]
Upon any failure, the method returns an error display string.
msg:
description: Success or failure message
returned: always
type: string
sample: "VLAN configuration is accomplished"
'''
import sys

2
lib/ansible/modules/network/netconf/netconf_config.py
View file

@ -136,7 +136,7 @@ RETURN = '''
server_capabilities:
description: list of capabilities of the server
returned: success
type: list of strings
type: list
sample: ['urn:ietf:params:netconf:base:1.1','urn:ietf:params:netconf:capability:confirmed-commit:1.0','urn:ietf:params:netconf:capability:candidate:1.0']
'''

2
lib/ansible/modules/network/netvisor/pn_cluster.py
View file

@ -94,6 +94,8 @@ EXAMPLES = """
RETURN = """
command:
description: The CLI command run on the target node(s).
returned: always
type: str
stdout:
description: The set of responses from the cluster command.
returned: always

2
lib/ansible/modules/network/netvisor/pn_ospf.py
View file

@ -83,6 +83,8 @@ EXAMPLES = """
RETURN = """
command:
description: The CLI command run on the target node(s).
returned: always
type: str
stdout:
description: The set of responses from the ospf command.
returned: always

2
lib/ansible/modules/network/netvisor/pn_ospfarea.py
View file

@ -98,6 +98,8 @@ EXAMPLES = """
RETURN = """
command:
description: The CLI command run on the target node(s).
returned: always
type: str
stdout:
description: The set of responses from the ospf command.
returned: always

2
lib/ansible/modules/network/netvisor/pn_show.py
View file

@ -79,6 +79,8 @@ EXAMPLES = """
RETURN = """
command:
description: The CLI command run on the target node(s).
returned: always
type: str
stdout:
description: The set of responses from the show command.
returned: always

2
lib/ansible/modules/network/netvisor/pn_trunk.py
View file

@ -145,6 +145,8 @@ EXAMPLES = """
RETURN = """
command:
description: The CLI command run on the target node(s).
returned: always
type: str
stdout:
description: The set of responses from the trunk command.
returned: always

2
lib/ansible/modules/network/netvisor/pn_vlag.py
View file

@ -117,6 +117,8 @@ EXAMPLES = """
RETURN = """
command:
description: The CLI command run on the target node(s).
returned: always
type: str
stdout:
description: The set of responses from the vlag command.
returned: always

2
lib/ansible/modules/network/netvisor/pn_vlan.py
View file

@ -97,6 +97,8 @@ EXAMPLES = """
RETURN = """
command:
description: The CLI command run on the target node(s).
returned: always
type: str
stdout:
description: The set of responses from the vlan command.
returned: always

2
lib/ansible/modules/network/netvisor/pn_vrouter.py
View file

@ -131,6 +131,8 @@ EXAMPLES = """
RETURN = """
command:
description: The CLI command run on the target node(s).
returned: always
type: str
stdout:
description: The set of responses from the vrouter command.
returned: always

2
lib/ansible/modules/network/netvisor/pn_vrouterbgp.py
View file

@ -144,6 +144,8 @@ EXAMPLES = """
RETURN = """
command:
description: The CLI command run on the target node(s).
returned: always
type: str
stdout:
description: The set of responses from the vrouterbpg command.
returned: always

8
lib/ansible/modules/network/netvisor/pn_vrouterif.py
View file

@ -141,13 +141,15 @@ EXAMPLES = """
"""
RETURN = """
vrouterifcmd:
command:
description: The CLI command run on the target node(s).
stdout/msg:
returned: always
type: str
stdout:
description: The set of responses from the vrouterif command.
returned: on success
type: list
stderr/msg:
stderr:
description: The set of error responses from the vrouterif command.
returned: on error
type: str

2
lib/ansible/modules/network/netvisor/pn_vrouterlbif.py
View file

@ -84,6 +84,8 @@ EXAMPLES = """
RETURN = """
command:
description: The CLI command run on the target node(s).
returned: always
type: str
stdout:
description: The set of responses from the vrouterlb command.
returned: always

1
lib/ansible/modules/network/nxos/_nxos_mtu.py
View file

@ -101,6 +101,7 @@ proposed:
existing:
description:
- k/v pairs of existing mtu/sysmtu on the interface/system
returned: always
type: dict
sample: {"mtu": "1600", "sysmtu": "9216"}
end_state:

1
lib/ansible/modules/network/nxos/nxos_aaa_server.py
View file

@ -130,6 +130,7 @@ proposed:
existing:
description:
- k/v pairs of existing aaa server
returned: always
type: dict
sample: {"deadtime": "0", "directed_request": "disabled",
"global_key": "unknown", "server_timeout": "5"}

1
lib/ansible/modules/network/nxos/nxos_aaa_server_host.py
View file

@ -132,6 +132,7 @@ proposed:
existing:
description:
- k/v pairs of existing configuration
returned: always
type: dict
sample: {}
end_state:

1
lib/ansible/modules/network/nxos/nxos_acl_interface.py
View file

@ -75,6 +75,7 @@ proposed:
"name": "ANSIBLE"}
existing:
description: k/v pairs of existing ACL applied to the interface
returned: always
type: dict
sample: {}
end_state:

1
lib/ansible/modules/network/nxos/nxos_hsrp.py
View file

@ -123,6 +123,7 @@ proposed:
sample: {"group": "30", "version": "2", "vip": "10.30.1.1"}
existing:
description: k/v pairs of existing hsrp info on the interface
returned: always
type: dict
sample: {}
end_state:

1
lib/ansible/modules/network/nxos/nxos_igmp_interface.py
View file

@ -183,6 +183,7 @@ proposed:
sample: {"asn": "65535", "router_id": "1.1.1.1", "vrf": "test"}
existing:
description: k/v pairs of existing BGP configuration
returned: always
type: dict
sample: {"asn": "65535", "bestpath_always_compare_med": false,
"bestpath_aspath_multipath_relax": false,

1
lib/ansible/modules/network/nxos/nxos_igmp_snooping.py
View file

@ -105,6 +105,7 @@ proposed:
existing:
description:
- k/v pairs of existing configuration
returned: always
type: dict
sample: {"group_timeout": "never", "link_local_grp_supp": false,
"report_supp": true, "snooping": true, "v3_report_supp": true}

1
lib/ansible/modules/network/nxos/nxos_install_os.py
View file

@ -101,6 +101,7 @@ EXAMPLES = '''
RETURN = '''
install_state:
description: Boot and install information.
returned: always
type: dictionary
sample: {

3
lib/ansible/modules/network/nxos/nxos_interface.py
View file

@ -142,6 +142,7 @@ proposed:
sample: {"admin_state": "down"}
existing:
description: k/v pairs of existing switchport
returned: always
type: dict
sample: {"admin_state": "up", "description": "None",
"interface": "port-channel101", "mode": "layer2",
@ -149,7 +150,7 @@ existing:
end_state:
description: k/v pairs of switchport after module execution
returned: always
type: dict or null
type: dict
sample: {"admin_state": "down", "description": "None",
"interface": "port-channel101", "mode": "layer2",
"type": "portchannel", "ip_forward": "enable"}

1
lib/ansible/modules/network/nxos/nxos_ip_interface.py
View file

@ -89,6 +89,7 @@ proposed:
sample: {"addr": "20.20.20.20", "interface": "ethernet1/32", "mask": "24"}
existing:
description: k/v pairs of existing IP attributes on the interface
returned: always
type: dict
sample: {"addresses": [{"addr": "11.11.11.11", "mask": 17}],
"interface": "ethernet1/32", "prefix": "11.11.0.0",

1
lib/ansible/modules/network/nxos/nxos_ntp.py
View file

@ -102,6 +102,7 @@ proposed:
existing:
description:
- k/v pairs of existing ntp server/peer
returned: always
type: dict
sample: {"address": "2.2.2.2", "key_id": "32",
"peer_type": "server", "prefer": "enabled",

1
lib/ansible/modules/network/nxos/nxos_ntp_auth.py
View file

@ -98,6 +98,7 @@ proposed:
existing:
description:
- k/v pairs of existing ntp authentication
returned: always
type: dict
sample: {"authentication": "off", "trusted_key": "false"}
end_state:

1
lib/ansible/modules/network/nxos/nxos_ntp_options.py
View file

@ -85,6 +85,7 @@ proposed:
existing:
description:
- k/v pairs of existing ntp options
returned: always
type: dict
sample: {"logging": true, "master": true, "stratum": "8"}
end_state:

1
lib/ansible/modules/network/nxos/nxos_pim_interface.py
View file

@ -159,6 +159,7 @@ proposed:
existing:
description:
- k/v pairs of existing configuration
returned: always
type: dict
sample: {"border": false, "dr_prio": "1", "hello_interval": "30000",
"isauth": false, "jp_bidir": false, "jp_policy_in": "JPIN",

1
lib/ansible/modules/network/nxos/nxos_portchannel.py
View file

@ -96,6 +96,7 @@ proposed:
existing:
description:
- k/v pairs of existing portchannel
returned: always
type: dict
sample: {"group": "12", "members": ["Ethernet2/5",
"Ethernet2/6"], "members_detail": {

3
lib/ansible/modules/network/nxos/nxos_snmp_community.py
View file

@ -80,12 +80,13 @@ proposed:
sample: {"group": "network-operator"}
existing:
description: k/v pairs of existing snmp community
returned: always
type: dict
sample: {}
end_state:
description: k/v pairs of snmp community after module execution
returned: always
type: dict or null
type: dict
sample: {"acl": "None", "group": "network-operator"}
updates:
description: commands sent to the device

1
lib/ansible/modules/network/nxos/nxos_snmp_contact.py
View file

@ -65,6 +65,7 @@ proposed:
sample: {"contact": "New_Test"}
existing:
description: k/v pairs of existing snmp contact
returned: always
type: dict
sample: {"contact": "Test"}
end_state:

3
lib/ansible/modules/network/nxos/nxos_snmp_host.py
View file

@ -106,6 +106,7 @@ proposed:
"snmp_type": "trap", "version": "v2c", "vrf_filter": "one_more_vrf"}
existing:
description: k/v pairs of existing snmp host
returned: always
type: dict
sample: {"community": "TESTING", "snmp_type": "trap",
"udp": "162", "v3": "noauth", "version": "v2c",
@ -114,7 +115,7 @@ existing:
end_state:
description: k/v pairs of switchport after module execution
returned: always
type: dict or null
type: dict
sample: {"community": "TESTING", "snmp_type": "trap",
"udp": "162", "v3": "noauth", "version": "v2c",
"vrf": "test_vrf", "vrf_filter": ["test_vrf",

3
lib/ansible/modules/network/nxos/nxos_snmp_location.py
View file

@ -72,12 +72,13 @@ proposed:
sample: {"location": "New_Test"}
existing:
description: k/v pairs of existing snmp location
returned: always
type: dict
sample: {"location": "Test"}
end_state:
description: k/v pairs of location info after module execution
returned: always
type: dict or null
type: dict
sample: {"location": "New_Test"}
updates:
description: command sent to the device

1
lib/ansible/modules/network/nxos/nxos_snmp_traps.py
View file

@ -80,6 +80,7 @@ proposed:
sample: {"group": "lldp"}
existing:
description: k/v pairs of existing trap status
returned: always
type: dict
sample: {"lldp": [{"enabled": "No",
"trap": "lldpRemTablesChange"}]}

1
lib/ansible/modules/network/nxos/nxos_snmp_user.py
View file

@ -93,6 +93,7 @@ proposed:
existing:
description:
- k/v pairs of existing configuration
returned: always
type: dict
sample: {"authentication": "no", "encrypt": "none",
"group": ["network-operator"], "user": "ntc"}

3
lib/ansible/modules/network/nxos/nxos_switchport.py
View file

@ -130,6 +130,7 @@ proposed:
sample: {"access_vlan": "10", "interface": "eth1/5", "mode": "access"}
existing:
description: k/v pairs of existing switchport
returned: always
type: dict
sample: {"access_vlan": "10", "access_vlan_name": "VLAN0010",
"interface": "Ethernet1/5", "mode": "access",
@ -138,7 +139,7 @@ existing:
end_state:
description: k/v pairs of switchport after module execution
returned: always
type: dict or null
type: dict
sample: {"access_vlan": "10", "access_vlan_name": "VLAN0010",
"interface": "Ethernet1/5", "mode": "access",
"native_vlan": "1", "native_vlan_name": "default",

1
lib/ansible/modules/network/nxos/nxos_udld.py
View file

@ -89,6 +89,7 @@ proposed:
existing:
description:
- k/v pairs of existing udld configuration
returned: always
type: dict
sample: {"aggressive": "disabled", "msg_time": "15"}
end_state:

1
lib/ansible/modules/network/nxos/nxos_udld_interface.py
View file

@ -87,6 +87,7 @@ proposed:
existing:
description:
- k/v pairs of existing configuration
returned: always
type: dict
sample: {"mode": "aggressive"}
end_state:

4
lib/ansible/modules/network/nxos/nxos_vlan.py
View file

@ -126,7 +126,7 @@ proposed:
description: k/v pairs of parameters passed into module (does not include
vlan_id or vlan_range)
returned: when debug enabled
type: dict or null
type: dict
sample: {"admin_state": "down", "name": "app_vlan",
"vlan_state": "suspend", "mapped_vni": "5000"}
existing:
@ -139,7 +139,7 @@ end_state:
description: k/v pairs of the VLAN after executing module or null
when using vlan_range
returned: when debug enabled
type: dict or null
type: dict
sample: {"admin_state": "down", "name": "app_vlan", "vlan_id": "20",
"vlan_state": "suspend", "mapped_vni": "5000"}
updates:

1
lib/ansible/modules/network/nxos/nxos_vpc.py
View file

@ -118,6 +118,7 @@ proposed:
"role_priority": "1000", "system_priority": "2000"}
existing:
description: k/v pairs of existing VPC configuration
returned: always
type: dict
sample: {"auto_recovery": true, "delay_restore": null,
"domain": "100", "peer_gw": true,

1
lib/ansible/modules/network/nxos/nxos_vpc_interface.py
View file

@ -78,6 +78,7 @@ proposed:
sample: {"portchannel": "100", "vpc": "10"}
existing:
description: k/v pairs of existing configuration
returned: always
type: dict
sample: {}
end_state:

1
lib/ansible/modules/network/nxos/nxos_vrf.py
View file

@ -98,6 +98,7 @@ proposed:
"vrf": "ntc"}
existing:
description: k/v pairs of existing vrf
returned: always
type: dict
sample: {"admin_state": "Up", "description": "Old test",
"vrf": "old_ntc"}

1
lib/ansible/modules/network/nxos/nxos_vrf_interface.py
View file

@ -80,6 +80,7 @@ proposed:
sample: {"interface": "loopback16", "vrf": "ntc"}
existing:
description: k/v pairs of existing vrf on the interface
returned: always
type: dict
sample: {"interface": "loopback16", "vrf": ""}
end_state:

1
lib/ansible/modules/network/nxos/nxos_vrrp.py
View file

@ -115,6 +115,7 @@ proposed:
"admin_state": "no shutdown"}
existing:
description: k/v pairs of existing vrrp info on the interface
returned: always
type: dict
sample: {}
end_state:

1
lib/ansible/modules/network/nxos/nxos_vtp_domain.py
View file

@ -65,6 +65,7 @@ proposed:
existing:
description:
- k/v pairs of existing vtp domain
returned: always
type: dict
sample: {"domain": "testing", "version": "2", "vtp_password": "\"}
end_state:

1
lib/ansible/modules/network/nxos/nxos_vtp_password.py
View file

@ -83,6 +83,7 @@ proposed:
existing:
description:
- k/v pairs of existing vtp
returned: always
type: dict
sample: {"domain": "ntc", "version": "1", "vtp_password": "ntc"}
end_state:

1
lib/ansible/modules/network/nxos/nxos_vtp_version.py
View file

@ -62,6 +62,7 @@ proposed:
existing:
description:
- k/v pairs of existing vtp
returned: always
type: dict
sample: {"domain": "testing", "version": "1", "vtp_password": "\"}
end_state:

2
lib/ansible/modules/network/omapi_host.py
View file

@ -117,7 +117,7 @@ changed:
lease:
description: dictionnary containing host informations
returned: success
type: dictionnary
type: complex
contains:
ip-address:
description: IP address, if there is.