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 |
|---|---|
adapter_policy string | Name of Adapter Configuration Policy to associate with this template. |
api_key_id string / required | Public API Key ID associated with the private key. If not set, the value of the INTERSIGHT_API_KEY_ID environment variable is used. |
api_private_key path / required | 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. |
api_uri string | URI used to access the Intersight API. If not set, the value of the INTERSIGHT_API_URI environment variable is used. Default: |
bios_policy string | Name of BIOS Policy to associate with this template. |
boot_order_policy string | Name of Boot Order Policy to associate with this template. |
certificate_policy string | Name of Certificate Management Policy to associate with this template. |
description aliases: descr string | 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(_). |
device_connector_policy string | Name of Device Connector Policy to associate with this template. |
drive_security_policy string | Name of Drive Security Policy to associate with this template. |
firmware_policy string | Name of Firmware Policy to associate with this template. |
ipmi_over_lan_policy string | Name of IPMI over LAN Policy to associate with this template. |
lan_connectivity_policy string | Name of LAN Connectivity Policy to associate with this template. |
ldap_policy string | Name of LDAP Policy to associate with this template. |
local_user_policy string | Name of Local User Policy to associate with this template. |
memory_policy string | Name of Memory Policy to associate with this template. |
name string / required | The name assigned to the Server Profile Template. The name must be between 1 and 62 alphanumeric characters, allowing special characters :-_. |
network_connectivity_policy string | Name of Network Connectivity Policy to associate with this template. |
ntp_policy string | Name of NTP Policy to associate with this template. |
organization string | 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: |
persistent_memory_policy string | Name of Persistent Memory Policy to associate with this template. |
power_policy string | Name of Power Policy to associate with this template. |
san_connectivity_policy string | Name of SAN Connectivity Policy to associate with this template. |
sd_card_policy string | Name of SD Card Policy to associate with this template. |
serial_over_lan_policy string | Name of Serial over LAN Policy to associate with this template. |
smtp_policy string | Name of SMTP Policy to associate with this template. |
snmp_policy string | Name of SNMP Policy to associate with this template. |
ssh_policy string | Name of SSH Policy to associate with this template. |
state string | If If Choices:
|
storage_policy string | Name of Storage Policy to associate with this template. |
syslog_policy string | Name of Syslog Policy to associate with this template. |
tags list / elements=dictionary | List of tags in Key:<user-defined key> Value:<user-defined value> format. |
target_platform string | The platform for which the server profile template is applicable.
Choices:
|
thermal_policy string | Name of Thermal Policy to associate with this template. |
use_proxy boolean | If Choices:
|
validate_certs boolean | Boolean control for verifying the api_uri TLS certificate Choices:
|
virtual_kvm_policy string | Name of Virtual KVM Policy to associate with this template. |
virtual_media_policy string | 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 |
|---|---|
api_response dictionary | The API response output returned by the specified resource. Returned: always Sample: |
Collection links
© 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_server_profile_template_module.html