Improve documentation. This way, antsiull-docs is mentioned the result values as 'facts' and not as regular return values.

This commit is contained in:
Felix Fontein 2020-10-26 20:24:31 +01:00
parent bbcf2f1010
commit fa4825ba5f

View file

@ -46,113 +46,118 @@ EXAMPLES = """
""" """
RETURN = """ RETURN = """
ansible_net_gather_subset: ansible_facts:
description: "Dictionary of ip geolocation facts for a host's IP address"
returned: always
type: dict
contains:
ansible_net_gather_subset:
description: The list of fact subsets collected from the device description: The list of fact subsets collected from the device
returned: always returned: always
type: list type: list
# default # default
ansible_net_model: ansible_net_model:
description: The model name returned from the device description: The model name returned from the device
returned: always returned: always
type: str type: str
ansible_net_serialnum: ansible_net_serialnum:
description: The serial number of the remote 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 operating system version running on the remote device description: The operating system version running on the remote device
returned: always returned: always
type: str type: str
ansible_net_hostname: ansible_net_hostname:
description: The configured hostname of the device description: The configured hostname of the device
returned: always returned: always
type: str type: str
ansible_net_arch: ansible_net_arch:
description: The CPU architecture of the device description: The CPU architecture of the device
returned: always returned: always
type: str type: str
version_added: 1.2.0 version_added: 1.2.0
ansible_net_uptime: ansible_net_uptime:
description: The uptime of the device description: The uptime of the device
returned: always returned: always
type: str type: str
version_added: 1.2.0 version_added: 1.2.0
ansible_net_cpu_load: ansible_net_cpu_load:
description: Current CPU load description: Current CPU load
returned: always returned: always
type: str type: str
version_added: 1.2.0 version_added: 1.2.0
# hardware # hardware
ansible_net_spacefree_mb: ansible_net_spacefree_mb:
description: The available disk space on the remote device in MiB description: The available disk space on the remote device in MiB
returned: when hardware is configured returned: when hardware is configured
type: dict type: dict
ansible_net_spacetotal_mb: ansible_net_spacetotal_mb:
description: The total disk space on the remote device in MiB description: The total disk space on the remote device in MiB
returned: when hardware is configured returned: when hardware is configured
type: dict type: dict
ansible_net_memfree_mb: ansible_net_memfree_mb:
description: The available free memory on the remote device in MiB description: The available free memory on the remote device in MiB
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 memory on the remote device in MiB description: The total memory on the remote device in MiB
returned: when hardware is configured returned: when hardware is configured
type: int type: int
# config # config
ansible_net_config: ansible_net_config:
description: The current active config from the device description: The current active config from the device
returned: when config is configured returned: when config is configured
type: str type: str
# interfaces # interfaces
ansible_net_all_ipv4_addresses: ansible_net_all_ipv4_addresses:
description: All IPv4 addresses configured on the device description: All IPv4 addresses configured on the device
returned: when interfaces is configured returned: when interfaces is configured
type: list type: list
ansible_net_all_ipv6_addresses: ansible_net_all_ipv6_addresses:
description: All IPv6 addresses configured on the device description: All IPv6 addresses configured on the device
returned: when interfaces is configured returned: when interfaces is configured
type: list type: list
ansible_net_interfaces: ansible_net_interfaces:
description: A hash of all interfaces running on the system description: A hash of all interfaces running on the system
returned: when interfaces is configured returned: when interfaces is configured
type: dict type: dict
ansible_net_neighbors: ansible_net_neighbors:
description: The list of neighbors from the remote device description: The list of neighbors from the remote device
returned: when interfaces is configured returned: when interfaces is configured
type: dict type: dict
# routing # routing
ansible_net_bgp_peer: ansible_net_bgp_peer:
description: The dict bgp peer description: The dict bgp peer
returned: peer information returned: peer information
type: dict type: dict
version_added: 1.2.0 version_added: 1.2.0
ansible_net_bgp_vpnv4_route: ansible_net_bgp_vpnv4_route:
description: The dict bgp vpnv4 route description: The dict bgp vpnv4 route
returned: vpnv4 route information returned: vpnv4 route information
type: dict type: dict
version_added: 1.2.0 version_added: 1.2.0
ansible_net_bgp_instance: ansible_net_bgp_instance:
description: The dict bgp instance description: The dict bgp instance
returned: bgp instance information returned: bgp instance information
type: dict type: dict
version_added: 1.2.0 version_added: 1.2.0
ansible_net_route: ansible_net_route:
description: The dict routes in all routing table description: The dict routes in all routing table
returned: routes information in all routing table returned: routes information in all routing table
type: dict type: dict
version_added: 1.2.0 version_added: 1.2.0
ansible_net_ospf_instance: ansible_net_ospf_instance:
description: The dict ospf instance description: The dict ospf instance
returned: ospf instance information returned: ospf instance information
type: dict type: dict
version_added: 1.2.0 version_added: 1.2.0
ansible_net_ospf_neighbor: ansible_net_ospf_neighbor:
description: The dict ospf neighbor description: The dict ospf neighbor
returned: ospf neighbor information returned: ospf neighbor information
type: dict type: dict