New in version 2.2.
parameter | required | default | choices | comments | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
gather_subset |
no | !config | When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include all, default, config, and neighbors. Can specify a list of values to include a larger subset. Values can also be used with an initial ! to specify that a specific subset should not be collected. | ||||||||||||||||||||||||||||||||||||
provider |
no | A dict object containing connection details. | |||||||||||||||||||||||||||||||||||||
|
- name: collect all facts from the device vyos_facts: gather_subset: all - name: collect only the config and default facts vyos_facts: gather_subset: config - name: collect everything exception the config vyos_facts: gather_subset: "!config"
Common return values are documented here Return Values, the following are the fields unique to this module:
name | description | returned | type | sample |
---|---|---|---|---|
ansible_net_commits | The set of available configuration revisions | when present | list | |
ansible_net_model | The device model string | always | str | |
ansible_net_serialnum | The serial number of the device | always | str | |
ansible_net_config | The running-config from the device | when config is configured | str | |
ansible_net_hostname | The configured system hostname | always | str | |
ansible_net_gather_subset | The list of subsets gathered by the module | always | list | |
ansible_net_version | The version of the software running | always | str | |
ansible_net_neighbors | The set of LLDP neighbors | when interface is configured | list |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is maintained by those with core commit privileges
For more information on what this means please read Module Support
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.