community.vmware.vmware_vc_infraprofile_info – List and Export VMware vCenter infra profile configs.
community.vmware.vmware_vc_infraprofile_info – List and Export VMware vCenter infra profile configs.
Note
This plugin is part of the community.vmware collection (version 1.6.0).
To install it use: ansible-galaxy collection install community.vmware
.
To use it in a playbook, specify: community.vmware.vmware_vc_infraprofile_info
.
New in version 1.0.0: of community.vmware
Synopsis
- Module to manage VMware vCenter infra profile configs.
- vCenter infra profile Library feature is introduced in vSphere 7.0 version, so this module is not supported in the earlier versions of vSphere.
- All variables and VMware object names are case sensitive.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.7
- PyVmomi
- vSphere Automation SDK
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
api string |
|
API which needs to be executed |
config_path string |
Config file path which contains infra profile config JSON data, supports both relative and absolute path. This parameter is required only when | |
decryption_key string |
decryption_key argument for while doing import profile task as of now its not taken into account form API team. | |
description string |
Description of about encryption or decryption key. | |
encryption_key string |
encryption_key argument for while doing import profile task as of now its not taken into account form API team. | |
hostname string |
The hostname or IP address of the vSphere vCenter server. If the value is not specified in the task, the value of environment variable | |
password string |
The password of the vSphere vCenter server. If the value is not specified in the task, the value of environment variable
| |
port integer |
Default: 443 |
The port number of the vSphere vCenter. If the value is not specified in the task, the value of environment variable |
profiles string |
A list of profile names to be exported, imported, and validated. This parameter is not required while running for List API, not for | |
protocol string |
|
The connection to protocol. |
username string |
The username of the vSphere vCenter server. If the value is not specified in the task, the value of environment variable
| |
validate_certs boolean |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable |
Notes
Note
- Tested on vSphere 7.0
Examples
- name: Get information about VC infraprofile
vmware_vc_infraprofile_info:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
delegate_to: localhost
- name: export vCenter appliance infra profile config
vmware_vc_infraprofile_info:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
api: "export"
profiles: "ApplianceManagement"
delegate_to: localhost
- name: validate vCenter appliance infra profile config
vmware_vc_infraprofile_info:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
api: "validate"
profiles: "ApplianceManagement"
config_path: "export.json"
- name: import vCenter appliance infra profile config
vmware_vc_infraprofile_info:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
api: "import"
profiles: "ApplianceManagement"
config_path: "import.json"
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
export_infra dictionary |
On success with API set as "export" |
A message about the exported file
Sample: {'export_config_json': 'json exported to file'} |
import_profile dictionary |
On success with API set as "import" |
A message about import on import_profile spec
Sample: {'changed': True, 'failed': False, 'status': '0.0'} |
list_infra list / elements=string |
on success with API as "list" |
A list of infra configs,
Sample: [{'info': 'ApplianceManagement', 'name': 'ApplianceManagement'}, {'info': 'ApplianceNetwork', 'name': 'ApplianceNetwork'}, {'info': 'Authentication & Authorization Management', 'name': 'AuthManagement'}] |
validate_infra dictionary |
On success with API set as "validate" |
A message about validate on exported file
Sample: {'changed': False, 'failed': False, 'status': 'VALID'} |
Authors
- Naveenkumar G P (@ngp)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/vmware/vmware_vc_infraprofile_info_module.html