cisco.ucs.ucs_storage_profile module – Configures storage profiles on Cisco UCS Manager

Note

This module is part of the cisco.ucs collection (version 1.14.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.ucs. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.ucs.ucs_storage_profile.

Synopsis

  • Configures storage profiles on Cisco UCS Manager.

Requirements

The below requirements are needed on the host that executes this module.

  • ucsmsdk

Parameters

Parameter

Comments

description

aliases: descr

string

The user-defined description of the storage profile.

Enter up to 256 characters.

You can use any characters or spaces except the following:

` (accent mark), (backslash), ^ (carat), ” (double quote), = (equal sign), > (greater than), < (less than), or ‘ (single quote).

hostname

string / required

IP address or hostname of Cisco UCS Manager.

Modules can be used with the UCS Platform Emulator https://cs.co/ucspe

local_luns

list / elements=dictionary

List of Local LUNs used by the storage profile.

auto_deploy

string

Whether the local LUN should be automatically deployed or not.

Choices:

  • "auto-deploy" ← (default)

  • "no-auto-deploy"

disk_policy_name

string

The disk group configuration policy to be applied to this local LUN.

expand_to_avail

string

Specifies that this LUN can be expanded to use the entire available disk group.

For each service profile, only one LUN can use this option.

Expand To Available option is not supported for already deployed LUN.

Choices:

  • "no" ← (default)

  • "yes"

fractional_size

string

Fractional size of this LUN in MB.

Default: "0"

name

string / required

The name of the local LUN.

size

string

Size of this LUN in GB.

The size can range from 1 to 10240 GB.

Default: "1"

state

string

If present, will verify local LUN is present on profile. If absent, will verify local LUN is absent on profile.

Choices:

  • "absent"

  • "present" ← (default)

name

string / required

The name of the storage profile.

This name can be between 1 and 16 alphanumeric characters.

You cannot use spaces or any special characters other than - (hyphen), “_” (underscore), : (colon), and . (period).

You cannot change this name after profile is created.

org_dn

string

The distinguished name (dn) of the organization where the resource is assigned.

Default: "org-root"

password

string / required

Password for Cisco UCS Manager authentication.

port

integer

Port number to be used during connection (by default uses 443 for https and 80 for http connection).

proxy

string

If use_proxy is no, specfies proxy to be used for connection. e.g. ‘http://proxy.xy.z:8080’

state

string

If present, will verify that the storage profile is present and will create if needed.

If absent, will verify that the storage profile is absent and will delete if needed.

Choices:

  • "absent"

  • "present" ← (default)

use_proxy

boolean

If no, will not use the proxy as defined by system environment variable.

Choices:

  • false

  • true ← (default)

use_ssl

boolean

If no, an HTTP connection will be used instead of the default HTTPS connection.

Choices:

  • false

  • true ← (default)

username

string

Username for Cisco UCS Manager authentication.

Default: "admin"

Examples

- name: Configure Storage Profile
  cisco.ucs.ucs_storage_profile:
    hostname: 172.16.143.150
    username: admin
    password: password
    name: DEE-StgProf
    local_luns:
    - name: Boot-LUN
      size: '60'
      disk_policy_name: DEE-DG
    - name: Data-LUN
      size: '200'
      disk_policy_name: DEE-DG

- name: Remove Storage Profile
  cisco.ucs.ucs_storage_profile:
    hostname: 172.16.143.150
    username: admin
    password: password
    name: DEE-StgProf
    state: absent

- name: Remove Local LUN from Storage Profile
  cisco.ucs.ucs_storage_profile:
    hostname: 172.16.143.150
    username: admin
    password: password
    name: DEE-StgProf
    local_luns:
    - name: Data-LUN
      state: absent

Authors

  • Sindhu Sudhir (@sisudhir)

  • David Soper (@dsoper2)

  • John McDonough (@movinalot)

  • CiscoUcs (@CiscoUcs)