vmware.vmware_rest.appliance_infraprofile_configs module – Exports the desired profile specification.
Note
This module is part of the vmware.vmware_rest collection (version 2.3.1).
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 vmware.vmware_rest.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: vmware.vmware_rest.appliance_infraprofile_configs.
New in vmware.vmware_rest 2.0.0
Synopsis
Exports the desired profile specification.
Requirements
The below requirements are needed on the host that executes this module.
vSphere 7.0.2 or greater
python >= 3.6
aiohttp
Parameters
Parameter |
Comments |
|---|---|
Custom description provided by the user. If unset description will be empty. |
|
Encryption Key to encrypt/decrypt profiles. If unset encryption will not be used for the profile. |
|
Profiles to be exported/imported. If unset or empty, all profiles will be returned. When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.appliance_infraprofile_configs. |
|
Timeout settings for client session. The maximal number of seconds for the whole operation including connection establishment, request sending and response. The default value is 300s. |
|
Choices:
|
|
The hostname or IP address of the vSphere vCenter If the value is not specified in the task, the value of environment variable |
|
The vSphere vCenter password If the value is not specified in the task, the value of environment variable |
|
You can use this optional parameter to set the location of a log file. This file will be used to record the HTTP REST interaction. The file will be stored on the host that run the module. If the value is not specified in the task, the value of environment variable |
|
The vSphere vCenter username If the value is not specified in the task, the value of environment variable |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Choices:
|
Notes
Note
Tested on vSphere 7.0.2
Examples
- name: Export the ApplianceManagement profile
vmware.vmware_rest.appliance_infraprofile_configs:
state: export
profiles:
- ApplianceManagement
register: result
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Export the ApplianceManagement profile Returned: On success Sample: |