vcenter_vm_guest_filesystem_directories

Creates a directory in the guest operating system

Collection: vmware.vmware_rest

Full Name: vmware.vmware_rest.vcenter_vm_guest_filesystem_directories

Synopsis

Creates a directory in the guest operating system

Parameters

Name	Type	Required	Default	Description
vcenter_hostname	string	yes		The hostname or IP address of the vSphere vCenter
If the value is not specified in the task, the value of environment variable C(VMWARE_HOST) will be used instead.
vcenter_username	string	yes		The vSphere vCenter username
If the value is not specified in the task, the value of environment variable C(VMWARE_USER) will be used instead.
vcenter_password	string	yes		The vSphere vCenter password
If the value is not specified in the task, the value of environment variable C(VMWARE_PASSWORD) will be used instead.
vcenter_validate_certs	bool		`true`	Allows connection when SSL certificates are not valid. Set to C(false) when certificates are not trusted.
If the value is not specified in the task, the value of environment variable C(VMWARE_VALIDATE_CERTS) will be used instead.
vcenter_rest_log_file	string			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 runs the module.
If the value is not specified in the task, the value of
environment variable C(VMWARE_REST_LOG_FILE) will be used instead.
session_timeout	float			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.
create_parents	bool			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.
credentials	dict	yes		The guest authentication data. This parameter is mandatory.
Valid attributes are:

C(interactive_session) (bool): If set, the operation will interact with the logged-in desktop session in the guest. This requires that the logged-on user matches the user specified by the Credentials. This is currently only supported for USERNAME_PASSWORD. ([‘absent’, ‘create_temporary’, ‘move’, ‘present’]) This key is required with [‘absent’, ‘create_temporary’, ‘move’, ‘present’].
C(type) (str): Types of guest credentials ([‘absent’, ‘create_temporary’, ‘move’, ‘present’]) This key is required with [‘absent’, ‘create_temporary’, ‘move’, ‘present’].
- Accepted values:
  - SAML_BEARER_TOKEN
  - USERNAME_PASSWORD
C(user_name) (str): For SAML_BEARER_TOKEN, this is the guest user to be associated with the credentials. For USERNAME_PASSWORD this is the guest username. If no user is specified for SAML_BEARER_TOKEN, a guest dependent mapping will decide what guest user account is applied. ([‘absent’, ‘create_temporary’, ‘move’, ‘present’])
C(password) (str): password This field is optional and it is only relevant when the value of Credentials.type is USERNAME_PASSWORD. ([‘absent’, ‘create_temporary’, ‘move’, ‘present’])
C(saml_token) (str): SAML Bearer Token This field is optional and it is only relevant when the value of Credentials.type is SAML_BEARER_TOKEN. ([‘absent’, ‘create_temporary’, ‘move’, ‘present’]) | | new_path | string | | | The complete path to where the directory is moved or its new name. It cannot be a path to an existing directory or an existing file. Required with I(state=[‘move’]) | | parent_path | string | | | The complete path to the directory in which to create the new directory. Directory If unset a guest-specific default will be used. | | path | string | | | The complete path to the directory to be created. Required with I(state=[‘absent’, ‘move’, ‘present’]) | | prefix | string | | | The prefix to be given to the new temporary directory. Required with I(state=[‘create_temporary’]) | | recursive | bool | | | If true, all files and subdirectories are also deleted. If false, the directory must be empty for the operation to succeed. If unset, any directory content is not deleted. | | state | string | | present | Operation to perform; allowed values: absent, create_temporary, move, present. | | suffix | string | | | The suffix to be given to the new temporary directory. Required with I(state=[‘create_temporary’]) | | vm | string | yes | | Virtual Machine to perform the operation on. The parameter must be the id of a resource returned by M(vmware.vmware_rest.vcenter_vm_info). This parameter is mandatory. |

Example

yaml

- name: Create a VM
  vmware.vmware_rest.vcenter_vm:
    placement:
      cluster: "{{ lookup('vmware.vmware_rest.cluster_moid', '/my_dc/host/my_cluster') }}"
      datastore: "{{ lookup('vmware.vmware_rest.datastore_moid', '/my_dc/datastore/local') }}"
      folder: "{{ lookup('vmware.vmware_rest.folder_moid', '/my_dc/vm') }}"
      resource_pool: "{{ lookup('vmware.vmware_rest.resource_pool_moid', '/my_dc/host/my_cluster/Resources') }}"
    name: test_vm1
    guest_OS: RHEL_7_64
    hardware_version: VMX_11
    memory:
      hot_add_enabled: true
      size_MiB: 1024
    disks:
    - type: SATA
      backing:
        type: VMDK_FILE
        vmdk_file: '[local] test_vm1/{{ disk_name }}.vmdk'
    - type: SATA
      new_vmdk:
        name: second_disk
        capacity: 32000000000
    cdroms:
    - type: SATA
      sata:
        bus: 0
        unit: 2
    nics:
    - backing:
        type: STANDARD_PORTGROUP
        network: "{{ lookup('vmware.vmware_rest.network_moid', '/my_dc/network/VM Network') }}"
  register: my_vm

- name: Create a directory in /tmp
  vmware.vmware_rest.vcenter_vm_guest_filesystem_directories:
    vm: '{{ my_vm.id }}'
    path: /tmp/my/path
    create_parents: true
    credentials:
      interactive_session: false
      type: USERNAME_PASSWORD
      user_name: root
      password: root