cisco.intersight.intersight_server_profile_template module – Manage Server Profile Templates in Cisco Intersight
Note
This module is part of the cisco.intersight collection (version 2.18.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install cisco.intersight.
To use it in a playbook, specify: cisco.intersight.intersight_server_profile_template.
Synopsis
Create, update, and delete Server Profile Templates on Cisco Intersight.
Server Profile Templates define a reusable configuration that can be used to derive multiple Server Profiles.
Policies are attached to the template via the PolicyBucket sub-resource endpoint.
To derive Server Profiles from a template, use the derive_profiles playbook included in this collection. See https://github.com/CiscoDevNet/intersight-ansible/blob/master/playbooks/derive_profiles.yml for details.
For more information see Cisco Intersight.
Parameters
Parameter |
Comments |
|---|---|
Name of Adapter Configuration Policy to associate with this template. |
|
Public API Key ID associated with the private key. If not set, the value of the INTERSIGHT_API_KEY_ID environment variable is used. |
|
Filename (absolute path) or string of PEM formatted private key data to be used for Intersight API authentication. If a string is used, Ansible vault should be used to encrypt string data. Ex. 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-----’ If not set, the value of the INTERSIGHT_API_PRIVATE_KEY environment variable is used. |
|
URI used to access the Intersight API. If not set, the value of the INTERSIGHT_API_URI environment variable is used. Default: |
|
Name of BIOS Policy to associate with this template. |
|
Name of Boot Order Policy to associate with this template. |
|
Name of Certificate Management Policy to associate with this template. |
|
The user-defined description of the Server Profile Template. Description can contain letters(a-z, A-Z), numbers(0-9), hyphen(-), period(.), colon(:), or an underscore(_). |
|
Name of Device Connector Policy to associate with this template. |
|
Name of Drive Security Policy to associate with this template. |
|
Name of Firmware Policy to associate with this template. |
|
Name of IPMI over LAN Policy to associate with this template. |
|
Name of LAN Connectivity Policy to associate with this template. |
|
Name of LDAP Policy to associate with this template. |
|
Name of Local User Policy to associate with this template. |
|
Name of Memory Policy to associate with this template. |
|
The name assigned to the Server Profile Template. The name must be between 1 and 62 alphanumeric characters, allowing special characters :-_. |
|
Name of Network Connectivity Policy to associate with this template. |
|
Name of NTP Policy to associate with this template. |
|
The name of the Organization this resource is assigned to. Templates and Policies that are created within a Custom Organization are applicable only to devices in the same Organization. Default: |
|
Name of Persistent Memory Policy to associate with this template. |
|
Name of Power Policy to associate with this template. |
|
Name of SAN Connectivity Policy to associate with this template. |
|
Name of SD Card Policy to associate with this template. |
|
Name of Serial over LAN Policy to associate with this template. |
|
Name of SMTP Policy to associate with this template. |
|
Name of SNMP Policy to associate with this template. |
|
Name of SSH Policy to associate with this template. |
|
If If Choices:
|
|
Name of Storage Policy to associate with this template. |
|
Name of Syslog Policy to associate with this template. |
|
List of tags in Key:<user-defined key> Value:<user-defined value> format. |
|
The platform for which the server profile template is applicable.
Choices:
|
|
Name of Thermal Policy to associate with this template. |
|
If Choices:
|
|
Boolean control for verifying the api_uri TLS certificate Choices:
|
|
Name of Virtual KVM Policy to associate with this template. |
|
Name of Virtual Media Policy to associate with this template. |
Examples
- name: Create a basic Server Profile Template
cisco.intersight.intersight_server_profile_template:
api_private_key: "{{ api_private_key }}"
api_key_id: "{{ api_key_id }}"
organization: "default"
name: "SPT-Standalone-Basic"
description: "Basic standalone server profile template"
target_platform: standalone
tags:
- Key: "Environment"
Value: "Production"
state: present
- name: Create a Server Profile Template with policies
cisco.intersight.intersight_server_profile_template:
api_private_key: "{{ api_private_key }}"
api_key_id: "{{ api_key_id }}"
organization: "default"
name: "SPT-FI-Production"
description: "FI-Attached template with policies"
target_platform: fi-attached
bios_policy: "BIOS-Production"
boot_order_policy: "Boot-UEFI"
firmware_policy: "FW-Latest"
ntp_policy: "NTP-Corp"
power_policy: "Power-Grid-Redundancy"
storage_policy: "Storage-M2-Boot"
lan_connectivity_policy: "LAN-Prod"
san_connectivity_policy: "SAN-Prod"
state: present
- name: Delete a Server Profile Template
cisco.intersight.intersight_server_profile_template:
api_private_key: "{{ api_private_key }}"
api_key_id: "{{ api_key_id }}"
name: "SPT-Standalone-Basic"
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The API response output returned by the specified resource. Returned: always Sample: |