cisco.intersight.intersight_server_profile 模块 – Cisco Intersight 的服务器配置文件配置

注意

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

如果您正在使用 ansible 包,您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装,请运行 ansible-galaxy collection list

要安装它,请使用: ansible-galaxy collection install cisco.intersight

要在 playbook 中使用它,请指定: cisco.intersight.intersight_server_profile

概要

  • Cisco Intersight 的服务器配置文件配置。

  • 用于配置具有已分配服务器和服务器策略的服务器配置文件。

  • 有关更多信息,请参阅 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"

assigned_server

字符串

已分配服务器的受管对象 ID (MOID)。

如果用户希望稍后分配服务器,则可以省略此选项。

bios_policy

字符串

要与此配置文件关联的 BIOS 策略的名称。

boot_order_policy

字符串

要与此配置文件关联的启动顺序策略的名称。

certificate_policy

字符串

要与此配置文件关联的证书策略的名称。

description

别名:descr

字符串

用户定义的服务器配置文件描述。

描述可以包含字母 (a-z, A-Z)、数字 (0-9)、连字符 (-)、句点 (.)、冒号 (:) 或下划线 (_)。

默认值: ""

drive_security_policy

字符串

要与此配置文件关联的驱动器安全策略的名称。

firmware_policy

字符串

要与此配置文件关联的固件策略的名称。

imc_access_policy

字符串

要与此配置文件关联的 IMC 访问策略的名称。

ipmi_over_lan_policy

字符串

要与此配置文件关联的 IPMI over LAN 策略的名称。

lan_connectivity_policy

字符串

要与此配置文件关联的 LAN 连接策略的名称。

ldap_policy

字符串

要与此配置文件关联的 LDAP 策略的名称。

local_user_policy

字符串

要与此配置文件关联的本地用户策略的名称。

name

字符串 / 必需

分配给服务器配置文件的名称。

名称必须介于 1 到 62 个字母数字字符之间,允许特殊字符 :-_。

network_connectivity_policy

字符串

要与此配置文件关联的网络连接策略的名称。

ntp_policy

字符串

要与此配置文件关联的 NTP 策略的名称。

organization

字符串

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

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

默认值: "default"

power_policy

字符串

要与此配置文件关联的电源策略的名称。

san_connectivity_policy

字符串

要与此配置文件关联的 SAN 连接策略的名称。

sd_card_policy

字符串

要与此配置文件关联的 SD 卡策略的名称。

serial_over_lan_policy

字符串

要与此配置文件关联的串行 over LAN 策略的名称。

smtp_policy

字符串

要与此配置文件关联的 SMTP 策略的名称。

snmp_policy

字符串

要与此配置文件关联的 SNMP 策略的名称。

ssh_policy

字符串

要与此配置文件关联的 SSH 策略的名称。

state

字符串

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

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

选择

  • "present" ← (默认)

  • "absent"

storage_policy

字符串

要与此配置文件关联的存储策略的名称。

syslog_policy

字符串

要与此配置文件关联的 Syslog 策略的名称。

tags

列表 / 元素=字典

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

默认值: []

target_platform

字符串

服务器配置文件适用的平台。

可以是独立模式下运行的服务器,也可以是连接到由 Intersight 管理的 Fabric Interconnect (FIAttached) 的服务器。

选择

  • "Standalone" ← (默认)

  • "FIAttached"

thermal_policy

字符串

要与此配置文件关联的热策略的名称。

use_proxy

布尔值

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

选择

  • false

  • true ← (默认)

validate_certs

布尔值

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

选择

  • false

  • true ← (默认)

virtual_kvm_policy

字符串

要与此配置文件关联的虚拟 KVM 策略的名称。

virtual_media_policy

字符串

要与此配置文件关联的虚拟介质策略的名称。

示例

- name: Configure Server Profile
  cisco.intersight.intersight_server_profile:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: SP-Server1
    target_platform: FIAttached
    tags:
      - Key: Site
        Value: SJC02
    description: Profile for Server1
    assigned_server: 5e3b517d6176752d319a9999
    boot_order_policy: COS-Boot
    imc_access_policy: sjc02-d23-access
    lan_connectivity_policy: sjc02-d23-lan
    local_user_policy: guest-admin
    ntp_policy: lab-ntp
    storage_policy: storage
    virtual_media_policy: COS-VM

- name: Delete Server Profile
  cisco.intersight.intersight_server_profile:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: SP-Server1
    state: absent

返回值

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

描述

api_repsonse

字典

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

返回: 总是

示例: {"api_response": {"AssignedServer": {"Moid": "5e3b517d6176752d319a0881", "ObjectType": "compute.Blade"}, "Name": "SP-IMM-6454-D23-1-1", "ObjectType": "server.Profile", "Tags": [{"Key": "Site", "Value": "SJC02"}], "TargetPlatform": "FIAttached", "Type": "instance"}}

作者

  • David Soper (@dsoper2)

  • Sid Nath (@SidNath21)

  • Tse Kai “Kevin” Chan (@BrightScale)

  • Soma Tummala (@SOMATUMMALA21)