Create Guest Filesystem Directories
Creates a directory in the guest operating system.
if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.
Request
URLURL
https://{api_host}/api/vcenter/vm/{vm}/guest/filesystem/directories?action=create
Path Parameters
Path Parameters
string
vm
Required
Virtual Machine to perform the operation on. The parameter must be an identifier for the resource type: VirtualMachine.
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
VmGuestFilesystemDirectoriesCreateRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"credentials": {
"interactive_session": false,
"type": "USERNAME_PASSWORD"
},
"path": "string"
}
string
path
Required
The complete path to the directory to be created.
boolean
create_parents
Optional
Whether any parent directories should be created. If any failure occurs, some parent directories could be left behind. If unset parent directories are not created.
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.already_exists : if path already exists. | com.vmware.vapi.std.errors.invalid_argument : if path is too long. The value of com.vmware.vapi.std.errors.Error#data will contain all the fields defined in the FileErrorDetails providing additional information about the failure. | com.vmware.vapi.std.errors.not_allowed_in_current_state : if the virtual machine is not running. | com.vmware.vapi.std.errors.unsupported : if the operation is not supported by the VMware Tools in the guest operating system. if the operation is disabled by the VMware Tools in the guest operating system.
403
com.vmware.vapi.std.errors.unauthorized : if path cannot be created because the guest authentication will not allow the operation.
404
com.vmware.vapi.std.errors.not_found : if the virtual machine is not found. if path does not exist and createParents is not set. The value of com.vmware.vapi.std.errors.Error#data will contain all the fields defined in the FileErrorDetails providing additional information 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
$VmGuestCredentials = Initialize-VmGuestCredentials -InteractiveSession $false -Type "USERNAME_PASSWORD"
$VmGuestFilesystemDirectoriesCreateRequestBody = Initialize-VmGuestFilesystemDirectoriesCreateRequestBody -Credentials $VmGuestCredentials -Path "MyPath"
Invoke-CreateVmFilesystemDirectories -Vm "MyVm" -VmGuestFilesystemDirectoriesCreateRequestBody $VmGuestFilesystemDirectoriesCreateRequestBody
PowerCLI Client SDK All Parameters Example
$VmGuestCredentials = Initialize-VmGuestCredentials -InteractiveSession $false -Type "USERNAME_PASSWORD" -UserName "MyUserName" -Password "MyPassword" -SamlToken "MySamlToken"
$VmGuestFilesystemDirectoriesCreateRequestBody = Initialize-VmGuestFilesystemDirectoriesCreateRequestBody -Credentials $VmGuestCredentials -Path "MyPath" -CreateParents $false
Invoke-CreateVmFilesystemDirectories -Vm "MyVm" -VmGuestFilesystemDirectoriesCreateRequestBody $VmGuestFilesystemDirectoriesCreateRequestBody
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"create_parents":false,"credentials":{"interactive_session":false,"password":"string","saml_token":"string","type":"USERNAME_PASSWORD","user_name":"string"},"path":"string"}' https://{api_host}/api/vcenter/vm/{vm}/guest/filesystem/directories?action=create
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: create
Availability
Added in 7.0.2.0
