cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

update RETURNS doc string in ios_facts

Browse source 
updates the doc string for consistency and completeness
This commit is contained in:
Peter Sprygada 2016-08-25 19:44:58 -04:00
parent ef84dbbddd
commit e3b7bf0bf9
1 changed files with 47 additions and 39 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

86
network/ios/ios_facts.py
View file

@ -58,62 +58,70 @@ EXAMPLES = """
""" """
RETURN = """ RETURN = """
ansible_net_config: ansible_net_gather_subset:
description: The running-config from the device description: The list of fact subsets collected from the device
returned: when config is configured returned: always
type: str
ansible_net_interfaces:
description: The interfaces on the device
returned: when interfaces is configured
type: dict
ansible_net_filesystems:
description: A list of the filesystems on the device
returned: when hardware is configured
type: list type: list
ansible_net_hostname:
description: The configured system hostname # default
returned: always ansible_net_model:
type: str description: The model name returned from the device
ansible_net_image:
description: The image the system booted from
returned: always
type: str
ansible_net_module:
description: The device model string
returned: always returned: always
type: str type: str
ansible_net_serialnum: ansible_net_serialnum:
description: The serial number of the device description: The serial number of the remote device
returned: always returned: always
type: str type: str
ansible_net_version: ansible_net_version:
description: The version of the software running description: The operating system version running on the remote device
returned: always returned: always
type: str type: str
ansible_net_gather_subset: ansible_net_hostname:
description: The list of subsets gathered by the module description: The configured hostname of the device
returned: always returned: always
type: list type: string
ansible_net_all_ipv4_addresses: ansible_net_image:
description: The list of all IPv4 addresses configured on the device description: The image file the device is running
returned: when interface is configured returned: always
type: list type: string
ansible_net_all_ipv6_addresses:
description: The list of all ipv6 addresses configured on the device # hardware
returned: when interface is configured ansible_net_filesystems:
type: list description: All file system names availabe on the device
ansible_net_neighbors: returned: when hardware is configured
description: The set of LLDP neighbors
returned: when interface is configured
type: list type: list
ansible_net_memfree_mb: ansible_net_memfree_mb:
description: The amount of free processor memory description: The available free memory on the remote device in Mb
returned: when hardware is configured returned: when hardware is configured
type: int type: int
ansible_net_memtotal_mb: ansible_net_memtotal_mb:
description: The total amount of available processor memory description: The total memory on the remote device in Mb
returned: when hardware is configured returned: when hardware is configured
type: int type: int
# config
ansible_net_config:
description: The current active config from the device
returned: when config is configured
type: str
# interfaces
ansible_net_all_ipv4_addresses:
description: All IPv4 addresses configured on the device
returned: when interfaces is configured
type: list
ansible_net_all_ipv6_addresses:
description: All IPv6 addresses configured on the device
returned: when interfaces is configured
type: list
ansible_net_interfaces:
description: A hash of all interfaces running on the system
returned: when interfaces is configured
type: dict
ansible_net_neighbors:
description: The list of LLDP neighbors from the remote device
returned: when interfaces is configured
type: dict
""" """
import re import re