ansible.builtin.ucs_storage_profile (v2.9.0) — module

Configures storage profiles on Cisco UCS Manager

| "added in version" 2.7 of ansible.builtin"

Authors: Sindhu Sudhir (@sisudhir), David Soper (@dsoper2), CiscoUcs (@CiscoUcs)

preview | supported by certified

Install Ansible via pip

Install with pip install ansible==2.9.0

Description

Configures storage profiles on Cisco UCS Manager.

Examples can be used with the L(UCS Platform Emulator,https://communities.cisco.com/ucspe).


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Configure Storage Profile
  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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Remove Storage Profile
  ucs_storage_profile:
    hostname: 172.16.143.150
    username: admin
    password: password
    name: DEE-StgProf
    state: absent
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Remove Local LUN from Storage Profile
  ucs_storage_profile:
    hostname: 172.16.143.150
    username: admin
    password: password
    name: DEE-StgProf
    local_luns:
    - name: Data-LUN
      state: absent

Inputs

    
name:
    description:
    - 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.
    required: true

port:
    description:
    - Port number to be used during connection (by default uses 443 for https and 80 for
      http connection).
    type: int

proxy:
    description:
    - If use_proxy is no, specfies proxy to be used for connection. e.g. 'http://proxy.xy.z:8080'
    type: str

state:
    choices:
    - absent
    - present
    default: present
    description:
    - If C(present), will verify that the storage profile is present and will create if
      needed.
    - If C(absent), will verify that the storage profile is absent and will delete if
      needed.

org_dn:
    default: org-root
    description:
    - The distinguished name (dn) of the organization where the resource is assigned.

use_ssl:
    default: true
    description:
    - If C(no), an HTTP connection will be used instead of the default HTTPS connection.
    type: bool

hostname:
    description:
    - IP address or hostname of Cisco UCS Manager.
    - Modules can be used with the UCS Platform Emulator U(https://cs.co/ucspe)
    required: true
    type: str

password:
    description:
    - Password for Cisco UCS Manager authentication.
    required: true
    type: str

username:
    default: admin
    description:
    - Username for Cisco UCS Manager authentication.
    type: str

use_proxy:
    default: true
    description:
    - If C(no), will not use the proxy as defined by system environment variable.
    type: bool

local_luns:
    description:
    - List of Local LUNs used by the storage profile.
    suboptions:
      auto_deploy:
        choices:
        - auto-deploy
        - no-auto-deploy
        default: auto-deploy
        description:
        - Whether the local LUN should be automatically deployed or not.
      disk_policy_name:
        description:
        - The disk group configuration policy to be applied to this local LUN.
      expand_to_avail:
        default: 'no'
        description:
        - 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.
        type: bool
      fractional_size:
        default: '0'
        description:
        - Fractional size of this LUN in MB.
      name:
        description:
        - The name of the local LUN.
        required: true
      size:
        default: '1'
        description:
        - Size of this LUN in GB.
        - The size can range from 1 to 10240 GB.
      state:
        choices:
        - absent
        - present
        default: present
        description:
        - If C(present), will verify local LUN is present on profile. If C(absent), will
          verify local LUN is absent on profile.

description:
    aliases:
    - descr
    description:
    - 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).'