cisco.intersight.intersight_imc_access_policy 模块 – Cisco Intersight 的 IMC 访问策略配置

注意

此模块是 cisco.intersight 集合 (版本 2.0.20) 的一部分。

如果您使用的是 ansible 软件包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install cisco.intersight。

要在剧本中使用它，请指定： cisco.intersight.intersight_imc_access_policy。

概要

  • Cisco Intersight 的 IMC 访问策略配置。

  • 用于配置用于与 Cisco IMC 进行外部连接的 IP 地址和 VLAN。

  • 更多信息请参见 Cisco Intersight。

参数

参数

注释

api_key_id

字符串 / 必需

与私钥关联的公共 API 密钥 ID。

如果未设置，则使用 INTERSIGHT_API_KEY_ID 环境变量的值。

api_private_key

路径 / 必需

用于 Intersight API 身份验证的 PEM 格式私钥数据的文件名（绝对路径）或字符串。

如果使用字符串，则应使用 Ansible vault 加密字符串数据。

例如：ansible-vault encrypt_string –vault-id tme@/Users/dsoper/Documents/vault_password_file ‘—–BEGIN EC PRIVATE KEY—–

<您的私钥数据>

—–END EC PRIVATE KEY—–’

如果未设置，则使用 INTERSIGHT_API_PRIVATE_KEY 环境变量的值。

api_uri

字符串

用于访问 Intersight API 的 URI。

如果未设置，则使用 INTERSIGHT_API_URI 环境变量的值。

默认值： "https://intersight.com/api/v1"

description

别名：descr

字符串

IMC 访问策略的用户定义描述。

描述可以包含字母（az、AZ）、数字（0-9）、连字符（-）、句点（.）、冒号（:）或下划线（_）。

ip_pool

字符串 / 必需

用于分配 IP 地址和其他所需网络设置的 IP 池。

name

字符串 / 必需

分配给 IMC 访问策略的名称。

名称必须在 1 到 62 个字母数字字符之间，允许使用特殊字符 :-_。

organization

字符串

此资源分配到的组织的名称。

在自定义组织内创建的配置文件和策略仅适用于同一组织中的设备。

默认值： "default"

out_of_band

布尔值

如果 true，将启用带外配置。

如果 false，将启用带内配置。

选项

  • false ← (默认)

  • true

state

字符串

如果 present，将验证资源是否存在，如果需要则创建。

如果 absent，将验证资源是否不存在，如果需要则删除。

选项

  • "present" ← (默认)

  • "absent"

tags

列表 / 元素=字典

以 Key:<用户定义的键> Value:<用户定义的值> 格式列出的标签。

use_proxy

布尔值

如果 no，即使目标主机上的环境变量中定义了代理，也不会使用代理。

选项

  • false

  • true ← (默认)

validate_certs

布尔值

用于验证 api_uri TLS 证书的布尔值控制。

选项

  • false

  • true ← (默认)

vlan_id

整数

用于通过带内网络访问服务器的 VLAN。

如果 out_of_band 为 false，则需要。

示例

- name: Configure IMC Access policy
  intersight_imc_access_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: sjc02-d23-access
    description: IMC access for SJC02 rack D23
    tags:
      - Site: D23
    vlan_id: 131
    ip_pool: sjc02-d23-ext-mgmt

- name: Delete IMC Access policy
  intersight_imc_access_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: sjc02-d23-access
    state: absent

返回值

常见的返回值已在此处记录，以下是此模块独有的字段

键

描述

api_repsonse

字典

由指定资源返回的API响应输出。

返回值：始终返回

示例： {"api_response": {"Name": "sjc02-d23-access", "ObjectType": "access.Policy", "Profiles": [{"Moid": "5e4ec7ae77696e2d30840cfc", "ObjectType": "server.Profile"}, {"Moid": "5e84d78777696e2d302ec195", "ObjectType": "server.Profile"}], "Tags": [{"Key": "Site", "Value": "SJC02"}]}}

作者

  • David Soper (@dsoper2)