community.general.oneview_logical_interconnect_group module – Manage OneView Logical Interconnect Group resources
Note
This module is part of the community.general collection (version 8.6.4).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.general
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.general.oneview_logical_interconnect_group
.
Synopsis
Provides an interface to manage Logical Interconnect Group resources. Can create, update, or delete.
Aliases: remote_management.oneview.oneview_logical_interconnect_group
Requirements
The below requirements are needed on the host that executes this module.
Python >= 2.7.9
hpOneView >= 4.0.0
Parameters
Parameter |
Comments |
---|---|
OneView API Version. |
|
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. |
|
List with the Logical Interconnect Group properties. |
|
IP address or hostname for the appliance. |
|
IP address or hostname for the HPE Image Streamer REST API. |
|
Password for API authentication. |
|
Indicates the desired state for the Logical Interconnect Group resource. Choices:
|
|
Username for API authentication. |
|
When the ETag Validation is enabled, the request will be conditionally processed only if the current ETag for the resource matches the ETag provided in the data. Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: none |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
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: Ensure that the Logical Interconnect Group is present
community.general.oneview_logical_interconnect_group:
config: /etc/oneview/oneview_config.json
state: present
data:
name: Test Logical Interconnect Group
uplinkSets: []
enclosureType: C7000
interconnectMapTemplate:
interconnectMapEntryTemplates:
- logicalDownlinkUri: ~
logicalLocation:
locationEntries:
- relativeValue: 1
type: Bay
- relativeValue: 1
type: Enclosure
permittedInterconnectTypeName: HP VC Flex-10/10D Module
# Alternatively you can inform permittedInterconnectTypeUri
delegate_to: localhost
- name: Ensure that the Logical Interconnect Group has the specified scopes
community.general.oneview_logical_interconnect_group:
config: /etc/oneview/oneview_config.json
state: present
data:
name: Test Logical Interconnect Group
scopeUris:
- /rest/scopes/00SC123456
- /rest/scopes/01SC123456
delegate_to: localhost
- name: Ensure that the Logical Interconnect Group is present with name 'Test'
community.general.oneview_logical_interconnect_group:
config: /etc/oneview/oneview_config.json
state: present
data:
name: New Logical Interconnect Group
newName: Test
delegate_to: localhost
- name: Ensure that the Logical Interconnect Group is absent
community.general.oneview_logical_interconnect_group:
config: /etc/oneview/oneview_config.json
state: absent
data:
name: New Logical Interconnect Group
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Has the facts about the OneView Logical Interconnect Group. Returned: On state ‘present’. Can be null. |