dellemc.unity.cifsserver (2.0.0) — module

Manage CIFS server on Unity storage system

| "added in version" 1.4.0 of dellemc.unity"

Authors: Akash Shendge (@shenda1) <ansible.team@dell.com>

Install collection

Install with ansible-galaxy collection install dellemc.unity:==2.0.0


Add to requirements.yml

  collections:
    - name: dellemc.unity
      version: 2.0.0

Description

Managing the CIFS server on the Unity storage system includes creating CIFS server, getting CIFS server details and deleting CIFS server.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create CIFS server belonging to Active Directory
  dellemc.unity.cifsserver:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    nas_server_name: "test_nas1"
    cifs_server_name: "test_cifs"
    domain: "ad_domain"
    domain_username: "domain_username"
    domain_password: "domain_password"
    state: "present"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get CIFS server details using CIFS server ID
  dellemc.unity.cifsserver:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    cifs_server_id: "cifs_37"
    state: "present"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get CIFS server details using NAS server name
  dellemc.unity.cifsserver:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    nas_server_name: "test_nas1"
    state: "present"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete CIFS server
  dellemc.unity.cifsserver:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    cifs_server_id: "cifs_37"
    unjoin_cifs_server_account: true
    domain_username: "domain_username"
    domain_password: "domain_password"
    state: "absent"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create standalone CIFS server
  dellemc.unity.cifsserver:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    netbios_name: "ANSIBLE_CIFS"
    workgroup: "ansible"
    local_password: "Password123!"
    nas_server_name: "test_nas1"
    state: "present"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Get CIFS server details using netbios name
  dellemc.unity.cifsserver:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    netbios_name: "ANSIBLE_CIFS"
    state: "present"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete standalone CIFS server
  dellemc.unity.cifsserver:
    unispherehost: "{{unispherehost}}"
    username: "{{username}}"
    password: "{{password}}"
    validate_certs: "{{validate_certs}}"
    cifs_server_id: "cifs_40"
    state: "absent"

Inputs

    
port:
    default: 443
    description:
    - Port number through which communication happens with Unity management server.
    type: int

state:
    choices:
    - absent
    - present
    description:
    - Define whether the CIFS server should exist or not.
    required: true
    type: str

domain:
    description:
    - The domain name where the SMB server is registered in Active Directory.
    type: str

password:
    description:
    - The password of the Unity management server.
    required: true
    type: str

username:
    description:
    - The username of the Unity management server.
    required: true
    type: str

workgroup:
    description:
    - Standalone SMB server workgroup.
    type: str

interfaces:
    description:
    - List of file IP interfaces that service CIFS protocol of SMB server.
    elements: str
    type: list

netbios_name:
    description:
    - The computer name of the SMB server in Windows network.
    type: str

nas_server_id:
    description:
    - ID of the NAS server on which CIFS server will be hosted.
    type: str

unispherehost:
    description:
    - IP or FQDN of the Unity management server.
    required: true
    type: str

cifs_server_id:
    description:
    - The ID of the CIFS server.
    type: str

local_password:
    description:
    - Standalone SMB server administrator password.
    type: str

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

domain_password:
    description:
    - Active Directory domain password.
    type: str

domain_username:
    description:
    - Active Directory domain user name.
    type: str

nas_server_name:
    description:
    - Name of the NAS server on which CIFS server will be hosted.
    type: str

cifs_server_name:
    description:
    - The name of the CIFS server.
    type: str

unjoin_cifs_server_account:
    description:
    - Keep SMB server account unjoined in Active Directory after deletion.
    - C(false) specifies keep SMB server account joined after deletion.
    - C(true) specifies unjoin SMB server account from Active Directory before deletion.
    type: bool

Outputs

changed:
  description: Whether or not the resource has changed.
  returned: always
  sample: true
  type: bool
cifs_server_details:
  contains:
    description:
      description: Description of the SMB server.
      type: str
    domain:
      description: Domain name where SMB server is registered in Active Directory.
      type: str
    file_interfaces:
      contains:
        UnityFileInterfaceList:
          contains:
            UnityFileInterface:
              contains:
                id:
                  description: Unique identifier of the file interface.
                  type: str
              description: Details of file interface associated with the NAS server.
              type: dict
          description: List of file interfaces associated with the NAS server.
          type: list
      description: The file interfaces associated with the NAS server.
      type: dict
    id:
      description: Unique identifier of the CIFS server instance.
      type: str
    is_standalone:
      description: Indicates whether the SMB server is standalone.
      type: bool
    name:
      description: User-specified name for the SMB server.
      type: str
    nasServer:
      contains:
        UnityNasServer:
          contains:
            id:
              description: Unique identifier of the NAS server instance.
              type: str
          description: Information about the NAS server in the storage system.
          type: dict
      description: Information about the NAS server in the storage system.
      type: dict
    netbios_name:
      description: Computer Name of the SMB server in windows network.
      type: str
    smb_multi_channel_supported:
      description: Indicates whether the SMB 3.0+ multichannel feature is supported.
      type: bool
    smb_protocol_versions:
      description: Supported SMB protocols, such as 1.0, 2.0, 2.1, 3.0, and so on.
      type: list
    smbca_supported:
      description: Indicates whether the SMB server supports continuous availability.
      type: bool
    workgroup:
      description: Windows network workgroup for the SMB server.
      type: str
  description: Details of the CIFS server.
  returned: When CIFS server exists
  sample:
    description: null
    domain: xxx.xxx.xxx.com
    existed: true
    file_interfaces:
      UnityFileInterfaceList:
      - UnityFileInterface:
          hash: -9223363258905013637
          id: if_43
    hash: -9223363258905010379
    health:
      UnityHealth:
        hash: 8777949765559
    id: cifs_40
    is_standalone: false
    last_used_organizational_unit: ou=Computers,ou=Dell NAS servers
    name: ansible_cifs
    nas_server:
      UnityNasServer:
        hash: 8777949765531
        id: nas_18
    netbios_name: ANSIBLE_CIFS
    smb_multi_channel_supported: true
    smb_protocol_versions:
    - '1.0'
    - '2.0'
    - '2.1'
    - '3.0'
    smbca_supported: true
    workgroup: null
  type: dict