cisco.intersight.intersight_server_profile (2.0.8) — module

Server Profile configuration for Cisco Intersight

Authors: David Soper (@dsoper2), Sid Nath (@SidNath21), Tse Kai "Kevin" Chan (@BrightScale), Soma Tummala (@SOMATUMMALA21)

preview | supported by community

Install collection

Install with ansible-galaxy collection install cisco.intersight:==2.0.8


Add to requirements.yml

  collections:
    - name: cisco.intersight
      version: 2.0.8

Description

Server Profile configuration for Cisco Intersight.

Used to configure Server Profiles with assigned servers and server policies.

For more information see L(Cisco Intersight,https://intersight.com/apidocs).

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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

Inputs

    
name:
    description:
    - The name assigned to the Server Profile.
    - The name must be between 1 and 62 alphanumeric characters, allowing special characters
      :-_.
    required: true
    type: str

tags:
    default: []
    description:
    - List of tags in Key:<user-defined key> Value:<user-defined value> format.
    elements: dict
    type: list

state:
    choices:
    - present
    - absent
    default: present
    description:
    - If C(present), will verify the resource is present and will create if needed.
    - If C(absent), will verify the resource is absent and will delete if needed.
    type: str

api_uri:
    default: https://intersight.com/api/v1
    description:
    - URI used to access the Intersight API.
    - If not set, the value of the INTERSIGHT_API_URI environment variable is used.
    type: str

use_proxy:
    default: true
    description:
    - If C(no), it will not use a proxy, even if one is defined in an environment variable
      on the target hosts.
    type: bool

api_key_id:
    description:
    - Public API Key ID associated with the private key.
    - If not set, the value of the INTERSIGHT_API_KEY_ID environment variable is used.
    required: true
    type: str

ntp_policy:
    description:
    - Name of NTP Policy to associate with this profile.
    type: str

bios_policy:
    description:
    - Name of BIOS Policy to associate with this profile.
    type: str

description:
    aliases:
    - descr
    default: ''
    description:
    - The user-defined description of the Server Profile.
    - Description can contain letters(a-z, A-Z), numbers(0-9), hyphen(-), period(.), colon(:),
      or an underscore(_).
    type: str

snmp_policy:
    description:
    - Name of SNMP Policy to associate with this profile.
    type: str

organization:
    default: default
    description:
    - The name of the Organization this resource is assigned to.
    - Profiles and Policies that are created within a Custom Organization are applicable
      only to devices in the same Organization.
    type: str

syslog_policy:
    description:
    - Name of Syslog Policy to associate with this profile.
    type: str

storage_policy:
    description:
    - Name of Storage Policy to associate with this profile.
    type: str

thermal_policy:
    description:
    - Name of Thermal Policy to associate with this profile.
    type: str

validate_certs:
    default: true
    description:
    - Boolean control for verifying the api_uri TLS certificate
    type: bool

api_private_key:
    description:
    - 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.
    required: true
    type: path

assigned_server:
    description:
    - Managed Obect ID (MOID) of assigned server.
    - Option can be omitted if user wishes to assign server later.
    type: str

firmware_policy:
    description:
    - Name of Firmware Policy to associate with this profile.
    type: str

target_platform:
    choices:
    - Standalone
    - FIAttached
    default: Standalone
    description:
    - The platform for which the server profile is applicable.
    - Can either be a server that is operating in Standalone mode or which is attached
      to a Fabric Interconnect (FIAttached) managed by Intersight.
    type: str

boot_order_policy:
    description:
    - Name of Boot Order Policy to associate with this profile.
    type: str

imc_access_policy:
    description:
    - Name of IMC Access Policy to associate with this profile.
    type: str

local_user_policy:
    description:
    - Name of Local User Policy to associate with this profile.
    type: str

certificate_policy:
    description:
    - Name of Certificate Policy to associate with this profile.
    type: str

virtual_kvm_policy:
    description:
    - Name of Virtual KVM Policy to associate with this profile.
    type: str

ipmi_over_lan_policy:
    description:
    - Name of IPMI over LAN Policy to associate with this profile.
    type: str

virtual_media_policy:
    description:
    - Name of Virtual Media Policy to associate with this profile.
    type: str

drive_security_policy:
    description:
    - Name of Drive Security Policy to associate with this profile.
    type: str

serial_over_lan_policy:
    description:
    - Name of Serial over LAN Policy to associate with this profile.
    type: str

lan_connectivity_policy:
    description:
    - Name of LAN Connectivity Policy to associate with this profile.
    type: str

san_connectivity_policy:
    description:
    - Name of SAN Connectivity Policy to associate with this profile.
    type: str

Outputs

api_repsonse:
  description: The API response output returned by the specified resource.
  returned: always
  sample:
    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
  type: dict