oneview_logical_interconnect_group_info – Retrieve information about one or more of the OneView Logical Interconnect Groups¶
New in version 2.5.
Synopsis¶
Retrieve information about one or more of the Logical Interconnect Groups from OneView
This module was called
oneview_logical_interconnect_group_facts
before Ansible 2.9, returningansible_facts
. Note that the oneview_logical_interconnect_group_info module no longer returnsansible_facts
!
Aliases: oneview_logical_interconnect_group_facts
Requirements¶
The below requirements are needed on the host that executes this module.
hpOneView >= 2.0.1
python >= 2.7.9
Parameters¶
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 information about all Logical Interconnect Groups
oneview_logical_interconnect_group_info:
hostname: 172.16.101.48
username: administrator
password: my_password
api_version: 500
no_log: true
delegate_to: localhost
register: result
- debug:
msg: "{{ result.logical_interconnect_groups }}"
- name: Gather paginated, filtered and sorted information about Logical Interconnect Groups
oneview_logical_interconnect_group_info:
params:
start: 0
count: 3
sort: name:descending
filter: name=LIGName
hostname: 172.16.101.48
username: administrator
password: my_password
api_version: 500
no_log: true
delegate_to: localhost
register: result
- debug:
msg: "{{ result.logical_interconnect_groups }}"
- name: Gather information about a Logical Interconnect Group by name
oneview_logical_interconnect_group_info:
name: logical interconnect group name
hostname: 172.16.101.48
username: administrator
password: my_password
api_version: 500
no_log: true
delegate_to: localhost
register: result
- debug:
msg: "{{ result.logical_interconnect_groups }}"
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
logical_interconnect_groups
dictionary
|
Always, but can be null. |
Has all the OneView information about the Logical Interconnect Groups.
|
Status¶
This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]
Authors¶
Felipe Bulsoni (@fgbulsoni)
Thiago Miotto (@tmiotto)
Adriane Cardozo (@adriane-cardozo)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.