fortinet.fortimanager.fmgr_cloud_orchestawstemplate_autoscalenewvpc модуль – Облачное оркестрирование awstemplate autoscale new vpc

Примечание

Этот модуль является частью коллекции fortinet.fortimanager (версия 2.7.0).

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

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Для использования в книге задач укажите: fortinet.fortimanager.fmgr_cloud_orchestawstemplate_autoscalenewvpc.

Новое в fortinet.fortimanager 2.2.0

Описание
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Этот модуль позволяет настроить устройство FortiManager.
Примеры включают все параметры и значения, которые необходимо настроить из источников данных перед использованием.

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / required	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager; модуль продолжает выполнение без валидации параметров. Варианты: `false` ← (default) `true`
cloud_orchestawstemplate_autoscalenewvpc dictionary	Набор параметров верхнего уровня.
availability-zones string	Устарело, переименуйте в availability_zones. Зоны доступности.
custom-asset-container string	Устарело, переименуйте в custom_asset_container. Контейнер пользовательских ресурсов.
custom-asset-directory string	Устарело, переименуйте в custom_asset_directory. Каталог пользовательских ресурсов.
custom-identifier string	Устарело, переименуйте в custom_identifier. Пользовательский идентификатор.
faz-autoscale-admin-password any	(list) Устарело, переименуйте в faz_autoscale_admin_password. Пароль администратора автомасштабирования Faz.
faz-autoscale-admin-username string	Устарело, переименуйте в faz_autoscale_admin_username. Имя пользователя администратора автомасштабирования Faz.
faz-custom-private-ipaddress string	Устарело, переименуйте в faz_custom_private_ipaddress. Пользовательский частный IP-адрес Faz.
faz-instance-type string	Устарело, переименуйте в faz_instance_type. Тип экземпляра Faz. Варианты: `"h1.2xlarge"` `"h1.4xlarge"` `"h1.8xlarge"` `"m5.large"` `"m5.xlarge"` `"m5.2xlarge"` `"m5.4xlarge"` `"m5.12xlarge"` `"t2.medium"` `"t2.large"` `"t2.xlarge"`
faz-integration-options string	Устарело, переименуйте в faz_integration_options. Параметры интеграции Faz. Варианты: `"no"` `"yes"`
faz-version string	Устарело, переименуйте в faz_version. Версия Faz.
fgt-admin-cidr string	Устарело, переименуйте в fgt_admin_cidr. CIDR-адрес администратора FGT.
fgt-admin-port integer	Устарело, переименуйте в fgt_admin_port. Порт администратора FGT.
fgt-instance-type string	Устарело, переименуйте в fgt_instance_type. Тип экземпляра FGT. Варианты: `"t2.small"` `"c5.large"` `"c5.xlarge"` `"c5.2xlarge"` `"c5.4xlarge"` `"c5.9xlarge"`
fgt-psk-secret string	Устарело, переименуйте в fgt_psk_secret. Секретный ключ PSK FGT.
fgtasg-cool-down integer	Устарело, переименуйте в fgtasg_cool_down. Время ожидания Fgtasg.

fgtasg-desired-capacity-byol integer	Устарело, переименуйте в fgtasg_desired_capacity_byol. Желаемая емкость Fgtasg byol.
fgtasg-desired-capacity-payg integer	Устарело, переименуйте в fgtasg_desired_capacity_payg. Желаемая емкость Fgtasg payg.
fgtasg-health-check-grace-period integer	Устарело, переименуйте в fgtasg_health_check_grace_period. Период ожидания проверки работоспособности Fgtasg.
fgtasg-max-size-byol integer	Устарело, переименуйте в fgtasg_max_size_byol. Максимальный размер Fgtasg byol.
fgtasg-max-size-payg integer	Устарело, переименуйте в fgtasg_max_size_payg. Максимальный размер Fgtasg payg.
fgtasg-min-size-byol integer	Устарело, переименуйте в fgtasg_min_size_byol. Минимальный размер Fgtasg byol.
fgtasg-min-size-payg integer	Устарело, переименуйте в fgtasg_min_size_payg. Минимальный размер Fgtasg payg.
fgtasg-scale-in-threshold integer	Устарело, переименуйте в fgtasg_scale_in_threshold. Порог уменьшения масштаба Fgtasg.
fgtasg-scale-out-threshold integer	Устарело, переименуйте в fgtasg_scale_out_threshold. Порог увеличения масштаба Fgtasg.
fos-version string	Устарело, переименуйте в fos_version. Версия FOS.
get-license-grace-period integer	Устарело, переименуйте в get_license_grace_period. Период ожидания лицензии.
heartbeat-delay-allowance integer	Устарело, переименуйте в heartbeat_delay_allowance. Допустимая задержка сигнала «сердцебиение».
heartbeat-interval integer	Устарело, переименуйте в heartbeat_interval. Интервал сигнала «сердцебиение».
heartbeat-loss-count integer	Устарело, переименуйте в heartbeat_loss_count. Количество потерянных сигналов «сердцебиение».
internal-balancer-dns-name string	Устарело, переименуйте в internal_balancer_dns_name. Имя DNS внутреннего балансировщика.
internal-balancing-options string	Устарело, переименуйте в internal_balancing_options. Параметры внутреннего балансирования. Варианты: `"add a new internal load balancer"` `"use a load balancer specified below"` `"do not need one"`
internal-target-group-health-check-path string	Устарело, переименуйте в internal_target_group_health_check_path. Путь проверки работоспособности внутренней целевой группы.
key-pair-name string	Устарело, переименуйте в key_pair_name. Имя пары ключей.
lifecycle-hook-timeout integer	Устарело, переименуйте в lifecycle_hook_timeout. Время ожидания хука жизненного цикла.
loadbalancing-health-check-threshold integer	Устарело, переименуйте в loadbalancing_health_check_threshold. Порог проверки работоспособности балансировки нагрузки.

loadbalancing-traffic-port integer	Устарело, переименуйте в loadbalancing_traffic_port. Порт трафика балансировки нагрузки.
loadbalancing-traffic-protocol string	Устарело, переименуйте в loadbalancing_traffic_protocol. Протокол трафика балансировки нагрузки. Choices: `"HTTPS"` `"HTTP"` `"TCP"`
name string / required	Имя.
notification-email string	Устарело, переименуйте в notification_email. Email для уведомлений.
primary-election-timeout integer	Устарело, переименуйте в primary_election_timeout. Время ожидания выбора основного.
private-subnet1-cidr string	Устарело, переименуйте в private_subnet1_cidr. CIDR-адрес частной подсети 1.
private-subnet2-cidr string	Устарело, переименуйте в private_subnet2_cidr. CIDR-адрес частной подсети 2.
public-subnet1-cidr string	Устарело, переименуйте в public_subnet1_cidr. CIDR-адрес публичной подсети 1.
public-subnet2-cidr string	Устарело, переименуйте в public_subnet2_cidr. CIDR-адрес публичной подсети 2.
resource-tag-prefix string	Устарело, переименуйте в resource_tag_prefix. Префикс тега ресурса.
s3-bucket-name string	Устарело, переименуйте в s3_bucket_name. Имя S3-бакета.
s3-key-prefix string	Устарело, переименуйте в s3_key_prefix. Префикс ключа S3.
sync-recovery-count integer	Устарело, переименуйте в sync_recovery_count. Количество синхронных восстановлений.
terminate-unhealthy-vm string	Устарело, переименуйте в terminate_unhealthy_vm. Завершить работу неисправной виртуальной машины. Choices: `"no"` `"yes"`
use-custom-asset-location string	Устарело, переименуйте в use_custom_asset_location. Использовать пользовательское местоположение ресурсов. Choices: `"no"` `"yes"`
vpc-cidr string	Устарело, переименуйте в vpc_cidr. CIDR-адрес VPC.
enable_log boolean	Включить/Выключить ведение журнала для задачи. Choices: `false` ← (default) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method string	Переопределенный метод для базового запроса Json RPC. Choices: `"update"` `"set"` `"add"`
rc_failed list / elements=integer	Список кодов rc, с которыми будут переопределены условия сбоя.

rc_succeeded список / элементы=целое число	Список кодов rc, при которых условия будут считаться выполненными.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom строка	ADOM для блокировки в режиме работы FortiManager в пространстве рабочей области. Значение может быть глобальным и другими, включая корневой.
workspace_locking_timeout целое число	Максимальное время ожидания в секундах, пока другой пользователь не разблокирует рабочую область. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, все входные аргументы имеют наименование с использованием нижнего подчеркивания (snake_case). Пожалуйста, измените аргументы, такие как “var-name”, на “var_name”. Старые имена аргументов по-прежнему доступны, но вы получите предупреждения об устаревании. Вы можете проигнорировать это предупреждение, установив deprecation_warnings=False в ansible.cfg.
Работа в режиме блокировки рабочего пространства поддерживается в этом модуле FortiManager, параметры workspace_locking_adom и workspace_locking_timeout на верхнем уровне помогают в этой работе.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно, выполнение одного модуля может завершиться ошибкой, если возвращен ненулевой код rc. Вы также можете переопределить условия для завершения ошибкой или успехом с параметрами rc_failed и rc_succeeded

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Cloud orchest awstemplate autoscale new vpc
      fortinet.fortimanager.fmgr_cloud_orchestawstemplate_autoscalenewvpc:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: present # <value in [present, absent]>
        cloud_orchestawstemplate_autoscalenewvpc:
          availability_zones: <string>
          custom_asset_container: <string>
          custom_asset_directory: <string>
          custom_identifier: <string>
          faz_autoscale_admin_password: <list or string>
          faz_autoscale_admin_username: <string>
          faz_custom_private_ipaddress: <string>
          faz_instance_type: <value in [h1.2xlarge, h1.4xlarge, h1.8xlarge, ...]>
          faz_integration_options: <value in [no, yes]>
          faz_version: <string>
          fgt_admin_cidr: <string>
          fgt_admin_port: <integer>
          fgt_instance_type: <value in [t2.small, c5.large, c5.xlarge, ...]>
          fgt_psk_secret: <string>
          fgtasg_cool_down: <integer>
          fgtasg_desired_capacity_byol: <integer>
          fgtasg_desired_capacity_payg: <integer>
          fgtasg_health_check_grace_period: <integer>
          fgtasg_max_size_byol: <integer>
          fgtasg_max_size_payg: <integer>
          fgtasg_min_size_byol: <integer>
          fgtasg_min_size_payg: <integer>
          fgtasg_scale_in_threshold: <integer>
          fgtasg_scale_out_threshold: <integer>
          fos_version: <string>
          get_license_grace_period: <integer>
          heartbeat_delay_allowance: <integer>
          heartbeat_interval: <integer>
          heartbeat_loss_count: <integer>
          internal_balancer_dns_name: <string>
          internal_balancing_options: <value in [add a new internal load balancer, use a load balancer specified below, do not need one]>
          internal_target_group_health_check_path: <string>
          key_pair_name: <string>
          lifecycle_hook_timeout: <integer>
          loadbalancing_health_check_threshold: <integer>
          loadbalancing_traffic_port: <integer>
          loadbalancing_traffic_protocol: <value in [HTTPS, HTTP, TCP]>
          name: <string>
          notification_email: <string>
          primary_election_timeout: <integer>
          private_subnet1_cidr: <string>
          private_subnet2_cidr: <string>
          public_subnet1_cidr: <string>
          public_subnet2_cidr: <string>
          resource_tag_prefix: <string>
          s3_bucket_name: <string>
          s3_key_prefix: <string>
          sync_recovery_count: <integer>
          terminate_unhealthy_vm: <value in [no, yes]>
          use_custom_asset_location: <value in [no, yes]>
          vpc_cidr: <string>

Значения возврата

Общие значения возврата документированы здесь, следующие поля уникальны для этого модуля:

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в книге команд, не поддерживаются текущей версией FortiManager. Возвращается: сложное

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Ссылок на сборку

© 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/fortinet/fortimanager/fmgr_cloud_orchestawstemplate_autoscalenewvpc_module.html