Spec-Zone.ru › Ansible

vmware.vmware_rest.vcenter_vm_guest_filesystem_directories модуль — Создаёт директорию в гостевой операционной системе

Примечание

Этот модуль входит в состав коллекции vmware.vmware_rest (версия 3.2.0).

Эта коллекция, возможно, уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.

Для её установки используйте: ansible-galaxy collection install vmware.vmware_rest. Для использования этого модуля необходимы дополнительные требования. Подробнее см. Требования.

Для использования в книге задач укажите: vmware.vmware_rest.vcenter_vm_guest_filesystem_directories.

Добавлена в vmware.vmware_rest 2.0.0

  • Описание
  • Требования
  • Параметры
  • Примечания
  • Примеры

Описание

  • Создаёт директорию в гостевой операционной системе.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

  • vSphere 7.0.3 или более поздняя версия
  • python >= 3.6
  • aiohttp

Параметры

Параметр

Комментарии

create_parents

boolean

Следует ли создавать родительские каталоги. В случае сбоя некоторые родительские каталоги могут остаться.

Если не задано, родительские каталоги не создаются.

Варианты:

  • false
  • true

credentials

dictionary / required

Данные аутентификации гостя. Этот параметр обязателен.

Допустимые атрибуты:

  • interactive_session (bool): Если установлено, операция будет взаимодействовать с сеансом входа в систему на рабочем столе гостя. Для этого требуется, чтобы вошедший пользователь совпадал с пользователем, указанным в учетных данных. В настоящее время это поддерживается только для USERNAME_PASSWORD. ([‘absent’, ‘create_temporary’, ‘move’, ‘present’])

Этот ключ обязателен с [‘absent’, ‘create_temporary’, ‘move’, ‘present’].

  • type (str): Типы учетных данных гостя ([‘absent’, ‘create_temporary’, ‘move’, ‘present’])

Этот ключ обязателен с [‘absent’, ‘create_temporary’, ‘move’, ‘present’].

  • Допустимые значения:
  • SAML_BEARER_TOKEN
  • USERNAME_PASSWORD
  • user_name (str): Для SAML_BEARER_TOKEN это пользователь гостя, который будет связан с учетными данными. Для USERNAME_PASSWORD это имя пользователя гостя.

Если пользователь для SAML_BEARER_TOKEN не указан, сопоставление, зависящее от гостя, определит, какая учетная запись пользователя гостя применяется. ([‘absent’, ‘create_temporary’, ‘move’, ‘present’])

  • password (str): пароль

Это поле является необязательным и актуально только тогда, когда значение Credentials.type равно USERNAME_PASSWORD. ([‘absent’, ‘create_temporary’, ‘move’, ‘present’])

  • saml_token (str): Маркер носителя SAML

Это поле является необязательным и актуально только тогда, когда значение Credentials.type равно SAML_BEARER_TOKEN. ([‘absent’, ‘create_temporary’, ‘move’, ‘present’])

new_path

string

Полный путь к месту перемещения каталога или его новому имени. Это не может быть путь к существующему каталогу или существующему файлу. Требуется с state=[‘move’]

parent_path

string

Полный путь к каталогу, в котором будет создан новый каталог.

Каталог Если не задано, будет использовано значение по умолчанию, зависящее от гостя.

path

string

Полный путь к каталогу, который необходимо создать. Требуется с state=[‘absent’, ‘move’, ‘present’]

prefix

string

Префикс, который будет присвоен новому временному каталогу. Требуется с state=[‘create_temporary’]

recursive

boolean

Если true, все файлы и подкаталоги также будут удалены. Если false, каталог должен быть пустым, чтобы операция завершилась успешно.

Если не задано, содержимое каталога не удаляется.

Варианты:

  • false
  • true

session_timeout

float

добавлено в vmware.vmware_rest 2.1.0

Настройки времени ожидания для сеанса клиента.

Максимальное количество секунд для всей операции, включая установление соединения, отправку запроса и ответ.

Значение по умолчанию — 300 с.

state

string

Варианты:

  • "absent"
  • "create_temporary"
  • "move"
  • "present" ← (по умолчанию)

suffix

string

Суффикс, который будет присвоен новому временному каталогу. Требуется с state=[‘create_temporary’]

vcenter_hostname

string / required

Имя хоста или IP-адрес vSphere vCenter

Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_HOST.

vcenter_password

string / required

Пароль vSphere vCenter

Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_PASSWORD.

vcenter_rest_log_file

string

Этот необязательный параметр можно использовать для указания местоположения файла журнала.

Этот файл будет использоваться для записи взаимодействия HTTP REST.

Файл будет храниться на хосте, на котором выполняется модуль.

Если значение не указано в задаче, вместо него будет использовано значение

переменной среды VMWARE_REST_LOG_FILE.

vcenter_username

string / required

Имя пользователя vSphere vCenter

Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_USER.

vcenter_validate_certs

boolean

Разрешает подключение, когда SSL-сертификаты недействительны. Установите значение false, если сертификаты не являются доверенными.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды VMWARE_VALIDATE_CERTS.

Варианты:

  • false
  • true ← (по умолчанию)

vm

string / обязательно

Виртуальная машина, на которой выполняется операция.

Параметр должен содержать идентификатор ресурса, возвращаемого модулем vmware.vmware_rest.vcenter_vm_info. Этот параметр обязателен.

Примечания

Примечание

  • Проверено на vSphere 7.0.3

Примеры

- 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

Авторы

  • Команда Ansible Cloud (@ansible-collections)

Ссылки на коллекцию

  • Трекер проблем
  • Главная страница
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/vmware/vmware_rest/vcenter_vm_guest_filesystem_directories_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API