Import Profile Configs Task
Imports the desired profile specification.
Request
URLURL
https://{api_host}/api/appliance/infraprofile/configs?action=import&vmw-task=true
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
InfraprofileConfigsImportProfileSpec of mimetype application/json
Required
information to import the profile.
{
"config_spec": "string"
}
string
config_spec
Required
The JSON string representing the desired config specification.
profile_spec
Optional
The profile specification, if any only set if there is a profilespec avaliable for this import profilespec.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
202 Accepted returns
string
of type application/json
An identifier for the task created by this API invocation will be returned. If the non-async version of the operation returns a value, this id can be used with the CIS Get Task operation to fetch that value. The normal description of this operation’s return value will follow if one exists. Import version.
Errors
400
com.vmware.vapi.std.errors.not_allowed_in_current_state : If there is another operation in progress.
500
com.vmware.vapi.std.errors.error : If there is unknown internal error. The accompanying error message will give more details about the failure.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
$InfraprofileConfigsImportProfileSpec = Initialize-InfraprofileConfigsImportProfileSpec -ConfigSpec "MyConfigSpec"
Invoke-ImportInfraprofileConfigsAsync -InfraprofileConfigsImportProfileSpec $InfraprofileConfigsImportProfileSpec
PowerCLI Client SDK All Parameters Example
$InfraprofileConfigsProfilesSpec = Initialize-InfraprofileConfigsProfilesSpec -EncryptionKey "MyEncryptionKey" -Description "MyDescription" -Profiles "MyProfiles"
$InfraprofileConfigsImportProfileSpec = Initialize-InfraprofileConfigsImportProfileSpec -ConfigSpec "MyConfigSpec" -ProfileSpec $InfraprofileConfigsProfilesSpec
Invoke-ImportInfraprofileConfigsAsync -InfraprofileConfigsImportProfileSpec $InfraprofileConfigsImportProfileSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"config_spec":"string","profile_spec":{"description":"string","encryption_key":"string","profiles":["string"]}}' https://{api_host}/api/appliance/infraprofile/configs?action=import&vmw-task=true
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: import_profile_task
Availability
Added in 7.0.0.0
