cisco.intersight.intersight_server_profile (1.0.6) — module

Install collection

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

Add to requirements.yml

  collections:
    - name: cisco.intersight
      version: 1.0.6

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Configure Server Profile
  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
    imc_access_policy: sjc02-d23-access
    local_user_policy: guest-admin

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Delete Server Profile
  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

tags:
    description:
    - List of tags in Key:<user-defined key> Value:<user-defined value> format.

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.

api_uri:
    default: https://intersight.com/api/v1
    description:
    - URI used to access the Intersight API.
    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.
    required: true
    type: str

descrption:
    aliases:
    - descr
    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(_).

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.

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

api_private_key:
    description:
    - Filename (absolute path) of a PEM formatted file that contains your private key
      to be used for Intersight API authentication.
    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.

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.

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

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

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