dellemc.powerstore.smb_server (3.2.0) — module

Manage SMB server for PowerStore

| "added in version" 3.1.0 of dellemc.powerstore"

Authors: Trisha Datta (@trisha-dell) <ansible.team@dell.com>

Install collection

Install with ansible-galaxy collection install dellemc.powerstore:==3.2.0


Add to requirements.yml

  collections:
    - name: dellemc.powerstore
      version: 3.2.0

Description

Managing storage containers on PowerStore Storage System includes creating an SMB server, getting details of an SMB server, modifying an SMB server and deleting an SMB server.


Requirements

Usage examples

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

- name: Enable SMB server
  register: result
  dellemc.powerstore.smb_server:
    array_ip: "{{ array_ip }}"
    validate_certs: "{{ validate_certs }}"
    user: "{{ user }}"
    password: "{{ password }}"
    nas_server: "{{ nas_server_name }}"
    is_standalone: true
    netbios_name: "string"
    workgroup: "string"
    description: "string"
    local_admin_password: "string"
    state: "present"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get SMB server
  dellemc.powerstore.smb_server:
    array_ip: "{{ array_ip }}"
    validate_certs: "{{ validate_certs }}"
    user: "{{ user }}"
    password: "{{ password }}"
    smb_server_id: "{{ result.smb_server_details.id }}"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get SMB server with NAS server
  dellemc.powerstore.smb_server:
    array_ip: "{{ array_ip }}"
    validate_certs: "{{ validate_certs }}"
    user: "{{ user }}"
    password: "{{ password }}"
    nas_server: "{{ result.smb_server_details.nas_server_id }}"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Modify SMB server
  dellemc.powerstore.smb_server:
    array_ip: "{{ array_ip }}"
    validate_certs: "{{ validate_certs }}"
    user: "{{ user }}"
    password: "{{ password }}"
    smb_server_id: "{{ result.smb_server_details.id }}"
    netbios_name: "string2"
    workgroup: "string2"
    description: "string2"
    local_admin_password: "string2"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete SMB server
  dellemc.powerstore.smb_server:
    array_ip: "{{ array_ip }}"
    validate_certs: "{{ validate_certs }}"
    user: "{{ user }}"
    password: "{{ password }}"
    smb_server_id: "{{ result.smb_server_details.id }}"
    state: "absent"

Inputs

    
port:
    description:
    - Port number for the PowerStore array.
    - If not passed, it will take 443 as default.
    type: int

user:
    description:
    - The username of the PowerStore host.
    required: true
    type: str

state:
    choices:
    - absent
    - present
    default: present
    description:
    - Define whether the SMB server should be enabled or not.
    - For Delete operation only, it should be set to C(absent).
    type: str

domain:
    description:
    - Domain name where SMB server is registered in Active Directory, if applicable.
    type: str

timeout:
    default: 120
    description:
    - Time after which the connection will get terminated.
    - It is to be mentioned in seconds.
    type: int

array_ip:
    description:
    - IP or FQDN of the PowerStore management system.
    required: true
    type: str

password:
    description:
    - The password of the PowerStore host.
    required: true
    type: str

workgroup:
    description:
    - Windows network workgroup for the SMB server.
    - Applies to standalone SMB servers only.
    type: str

nas_server:
    description:
    - Unique identifier/name of the NAS server to which the network interface belongs,
      as defined by the I(nas_server) resource type.
    type: str

description:
    description:
    - Description of the SMB server in UTF-8 characters.
    type: str

netbios_name:
    description:
    - NetBIOS name is the network name of the standalone SMB server.
    type: str

computer_name:
    description:
    - DNS Name of the associated Computer Account when the SMB server is joined to an
      Active Directory domain.
    type: str

is_standalone:
    description:
    - Indicates whether the SMB server is standalone.
    - I(true) - SMB server is standalone.
    - I(false) - SMB server is joined to the Active Directory.
    type: bool

smb_server_id:
    description:
    - The unique identifier of the SMB server.
    type: str

validate_certs:
    aliases:
    - verifycert
    default: true
    description:
    - Boolean variable to specify whether to validate SSL certificate or not.
    - C(true) - indicates that the SSL certificate should be verified. Set the environment
      variable REQUESTS_CA_BUNDLE to the path of the SSL certificate.
    - C(false) - indicates that the SSL certificate should not be verified.
    type: bool

local_admin_password:
    description:
    - Password for the local administrator account of the SMB server.
    type: str

Outputs

changed:
  description: Whether or not the resource has changed.
  returned: always
  sample: 'false'
  type: bool
smb_server_details:
  contains:
    computer_name:
      description: DNS name of the associated computer account when the SMB server
        is joined to an Active Directory domain.
      type: str
    description:
      description: Description of the SMB server.
      type: str
    domain:
      description: Domain name where SMB server is registered in Active Directory,
        if applicable.
      type: str
    id:
      description: The unique identifier of the SMB server.
      type: str
    is_joined:
      description: Indicates whether the SMB server is joined to the Active Directory.
      type: bool
    is_standalone:
      description: Indicates whether the SMB server is standalone.
      type: bool
    nas_server_id:
      description: Unique identifier of the NAS server.
      type: str
    netbios_name:
      description: NetBIOS name is the network name of the standalone SMB server.
      type: str
    workgroup:
      description: Windows network workgroup for the SMB server.
      type: str
  description: Details of the SMB server.
  returned: When SMB server exists.
  sample:
    computer_name: null
    description: string2
    domain: null
    id: 65ad211b-374b-5f77-2946-62b767ad9845
    is_joined: false
    is_standalone: true
    nas_server_id: 6581683c-61a3-76ab-f107-62b767ad9845
    netbios_name: STRING2
    workgroup: STRING2
  type: complex