Модуль cisco.intersight.intersight_ssh_policy — настройка политики SSH для Cisco Intersight

Примечание

Этот модуль входит в коллекцию cisco.intersight (версия 2.18.0).

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

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

Чтобы использовать модуль в плейбуке, укажите: cisco.intersight.intersight_ssh_policy.

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

Краткое описание

Управляет настройками политики SSH в Cisco Intersight.
Политика для настройки параметров службы SSH на серверах, управляемых Cisco Intersight.
Эта политика применима только к серверам UCS (автономным).
Дополнительную информацию см. в Cisco Intersight.

Параметры

Параметр	Комментарии
api_key_id string / обязательный	Идентификатор открытого ключа API, связанного с закрытым ключом. Если значение не задано, используется значение переменной среды INTERSIGHT_API_KEY_ID.
api_private_key path / обязательный	Имя файла (абсолютный путь) или строка с данными закрытого ключа в формате PEM для аутентификации в API Intersight. Если используется строка, для шифрования строковых данных следует использовать Ansible Vault. Например: ansible-vault encrypt_string --vault-id tme@/Users/dsoper/Documents/vault_password_file ‘-----BEGIN EC PRIVATE KEY----- <your private key data> -----END EC PRIVATE KEY-----’ Если значение не задано, используется значение переменной среды INTERSIGHT_API_PRIVATE_KEY.
api_uri string	URI для доступа к API Intersight. Если значение не задано, используется значение переменной среды INTERSIGHT_API_URI. По умолчанию: `"https://intersight.com/api/v1"`
description псевдонимы: descr string	Описание политики SSH, заданное пользователем. Описание может содержать буквы (a-z, A-Z), цифры (0-9), дефис (-), точку (.), двоеточие (:) или знак подчёркивания (_).
enable_ssh boolean	Состояние службы SSH на конечной точке. Если задано значение false, служба SSH будет отключена, а параметры ssh_port и ssh_timeout будут игнорироваться. Варианты: `false` `true` ← (по умолчанию)
name string / обязательный	Имя, назначенное политике SSH. Имя должно содержать от 1 до 62 буквенно-цифровых символов; допускаются специальные символы :-_.
organization string	Имя организации, которой назначен этот ресурс. Профили и политики, созданные в пользовательской организации, применимы только к устройствам в той же организации. По умолчанию: `"default"`
ssh_port integer	Порт для безопасного доступа по SSH. Допустимый диапазон: 1–65535. Этот параметр используется только при значении enable_ssh true. По умолчанию: `22`
ssh_timeout integer	Количество секунд ожидания, по истечении которого система считает запрос SSH просроченным. Допустимый диапазон: 60–10800 секунд. Этот параметр используется только при значении enable_ssh true. По умолчанию: `1800`
state string	Если задано `present`, будет проверено наличие ресурса и при необходимости он будет создан. Если задано `absent`, будет проверено отсутствие ресурса и при необходимости он будет удалён. Варианты: `"present"` ← (по умолчанию) `"absent"`
tags list / elements=dictionary	Список тегов в формате «Ключ:<ключ, заданный пользователем> Значение:<значение, заданное пользователем>».
use_proxy boolean	Если задано `no`, прокси использоваться не будет, даже если он указан в переменной среды на целевых узлах. Варианты: `false` `true` ← (по умолчанию)
validate_certs boolean	Логический параметр для проверки TLS-сертификата api_uri. Варианты: `false` `true` ← (по умолчанию)

Примеры

- name: Create SSH Policy with default settings
  cisco.intersight.intersight_ssh_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "SSH-Policy-Default"
    description: "SSH policy with default settings"
    tags:
      - Key: "Environment"
        Value: "Production"
    enable_ssh: true
    state: present

- name: Create SSH Policy with custom port and timeout
  cisco.intersight.intersight_ssh_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "SSH-Policy-Custom"
    description: "SSH policy with custom port and timeout"
    enable_ssh: true
    ssh_port: 2222
    ssh_timeout: 3600
    state: present

- name: Create SSH Policy with SSH disabled
  cisco.intersight.intersight_ssh_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "SSH-Policy-Disabled"
    description: "SSH policy with SSH service disabled"
    enable_ssh: false
    state: present

- name: Delete SSH Policy
  cisco.intersight.intersight_ssh_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "SSH-Policy-Default"
    state: absent

Возвращаемые значения

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

Ключ	Описание
api_response dictionary	Выходные данные ответа API, возвращённые указанным ресурсом. Возвращается: всегда Пример: `{"api_response": {"Enabled": true, "Name": "SSH-Policy-Default", "ObjectType": "ssh.Policy", "Port": 22, "Tags": [{"Key": "Environment", "Value": "Production"}], "Timeout": 1800}}`

Авторы

Ron Gershburg (@rgershbu)

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

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/intersight/intersight_ssh_policy_module.html