oneview_network_set_facts – Retrieve facts about the OneView Network Sets¶
New in version 2.4.
Synopsis¶
Retrieve facts about the Network Sets from OneView.
Requirements¶
The below requirements are needed on the host that executes this module.
hpOneView >= 2.0.1
python >= 2.7.9
Parameters¶
| Parameter | Choices/Defaults | Comments |
|---|---|---|
|
config
path
|
Path to a .json configuration file containing the OneView client configuration. The configuration file is optional and when used should be present in the host running the ansible commands. If the file path is not provided, the configuration will be loaded from environment variables. For links to example configuration files or how to use the environment variables verify the notes section.
|
|
|
name
-
|
Network Set name.
|
|
|
options
-
|
List with options to gather facts about Network Set. Option allowed:
withoutEthernet. The option withoutEthernet retrieves the list of network_sets excluding Ethernet networks. |
|
|
params
dictionary
|
List of params to delimit, filter and sort the list of resources.
params allowed: -
start: The first item to return, using 0-based indexing. - count: The number of resources to return. - filter: A general filter/query string to narrow the list of items returned. - sort: The sort order of the returned data set. |
Notes¶
Note
A sample configuration file for the config parameter can be found at: https://github.com/HewlettPackard/oneview-ansible/blob/master/examples/oneview_config-rename.json
Check how to use environment variables for configuration at: https://github.com/HewlettPackard/oneview-ansible#environment-variables
Additional Playbooks for the HPE OneView Ansible modules can be found at: https://github.com/HewlettPackard/oneview-ansible/tree/master/examples
The OneView API version used will directly affect returned and expected fields in resources. Information on setting the desired API version and can be found at: https://github.com/HewlettPackard/oneview-ansible#setting-your-oneview-version
Examples¶
- name: Gather facts about all Network Sets
oneview_network_set_facts:
hostname: 172.16.101.48
username: administrator
password: my_password
api_version: 500
no_log: true
delegate_to: localhost
- debug: var=network_sets
- name: Gather paginated, filtered, and sorted facts about Network Sets
oneview_network_set_facts:
hostname: 172.16.101.48
username: administrator
password: my_password
api_version: 500
params:
start: 0
count: 3
sort: 'name:descending'
filter: name='netset001'
no_log: true
delegate_to: localhost
- debug: var=network_sets
- name: Gather facts about all Network Sets, excluding Ethernet networks
oneview_network_set_facts:
hostname: 172.16.101.48
username: administrator
password: my_password
api_version: 500
options:
- withoutEthernet
no_log: true
delegate_to: localhost
- debug: var=network_sets
- name: Gather facts about a Network Set by name
oneview_network_set_facts:
hostname: 172.16.101.48
username: administrator
password: my_password
api_version: 500
name: Name of the Network Set
no_log: true
delegate_to: localhost
- debug: var=network_sets
- name: Gather facts about a Network Set by name, excluding Ethernet networks
oneview_network_set_facts:
hostname: 172.16.101.48
username: administrator
password: my_password
api_version: 500
name: Name of the Network Set
options:
- withoutEthernet
no_log: true
delegate_to: localhost
- debug: var=network_sets
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
|
network_sets
dictionary
|
Always, but can be empty. |
Has all the OneView facts about the Network Sets.
|
Status¶
This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]