cisco.intersight.intersight_unified_edge_profile module – Unified Edge server profile template for 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_unified_edge_profile.

Synopsis

  • Creates validated server profile templates for Cisco Unified Edge nodes used in AI Factory edge inference deployments.

  • Provides hardware-specific presets for supported Unified Edge platforms (UCS XE9305, XE130c M8, XE150c M8) with appropriate thermal limits, power budgets, and expansion constraints.

  • Attaches user-specified policies for BIOS, boot, storage, network, and other configuration via the PolicyBucket mechanism.

  • For generic server profile template management, use cisco.intersight.intersight_server_profile_template instead.

  • For more information see Cisco Intersight.

Parameters

Parameter

Comments

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: "https://intersight.com/api/v1"

bios_policy

string

Name of BIOS Policy to associate with this template.

Consider using a policy created by cisco.intersight.intersight_bios_ai_tuning with the edge_ai tuning profile.

boot_order_policy

string

Name of Boot Order Policy to associate with this template.

description

aliases: descr

string

The user-defined description of the server profile template.

firmware_policy

string

Name of Firmware Policy to associate with this template.

hardware_platform

string / required

The Unified Edge hardware platform this template targets.

xe9305 targets the UCS XE9305 compact edge server. Designed for single-GPU or CPU-only inference at the edge with constrained thermal envelope and limited PCIe expansion.

xe130c_m8 targets the UCS XE130c M8 short-depth edge server. Supports up to 2 GPUs with moderate thermal headroom for inference workloads in ruggedized edge environments.

xe150c_m8 targets the UCS XE150c M8 edge compute server. Full-height edge server supporting up to 4 GPUs with higher power budget for demanding edge AI inference and light training workloads.

Choices:

  • "xe9305"

  • "xe130c_m8"

  • "xe150c_m8"

ipmi_over_lan_policy

string

Name of IPMI over LAN Policy to associate with this template.

kvm_policy

string

Name of Virtual KVM Policy to associate with this template.

lan_connectivity_policy

string

Name of LAN Connectivity Policy to associate with this template.

local_user_policy

string

Name of Local User 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.

Default: "default"

power_policy

string

Name of Power 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 present, will verify the resource is present and will create if needed.

If absent, will verify the resource is absent and will delete if needed.

Choices:

  • "present" ← (default)

  • "absent"

storage_policy

string

Name of Storage Policy to associate with this template.

Consider using a policy created by cisco.intersight.intersight_ai_storage_policy with the edge_compact storage profile.

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.

thermal_policy

string

Name of Thermal Policy to associate with this template.

If not specified, the hardware_platform preset will suggest an appropriate thermal mode.

use_proxy

boolean

If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.

Choices:

  • false

  • true ← (default)

validate_certs

boolean

Boolean control for verifying the api_uri TLS certificate

Choices:

  • false

  • true ← (default)

Examples

- name: Create XE9305 edge inference profile template
  cisco.intersight.intersight_unified_edge_profile:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: Edge-Sites
    name: spt-xe9305-inference
    description: XE9305 compact edge inference server
    hardware_platform: xe9305
    bios_policy: bios-edge-ai
    boot_order_policy: boot-uefi-nvme
    storage_policy: storage-edge-inference
    lan_connectivity_policy: lan-edge-mgmt

- name: Create XE130c M8 edge GPU inference template
  cisco.intersight.intersight_unified_edge_profile:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: spt-xe130c-gpu-inference
    description: XE130c M8 with 2 GPUs for edge inference
    hardware_platform: xe130c_m8
    bios_policy: bios-edge-ai
    storage_policy: storage-model-cache
    firmware_policy: fw-latest

- name: Create XE150c M8 high-performance edge template
  cisco.intersight.intersight_unified_edge_profile:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: spt-xe150c-training
    description: XE150c M8 for edge training and inference
    hardware_platform: xe150c_m8
    bios_policy: bios-gpu-inference-h100
    storage_policy: storage-ai-inference

- name: Delete edge profile template
  cisco.intersight.intersight_unified_edge_profile:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: spt-xe9305-inference
    hardware_platform: xe9305
    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: {"api_response": {"Name": "spt-xe9305-inference", "ObjectType": "server.ProfileTemplate", "TargetPlatform": "UnifiedEdgeServer"}}

hardware_constraints

dictionary

Hardware constraints and recommendations for the selected platform.

Returned: when state is present

Authors

  • Steve Fulmer (@stevefulme1)