huawei.enterprise.hw_enterprise_cifs_share_client module – CIFS Share Client operations for Huawei Enterprise Storage

Note

This module is part of the huawei.enterprise collection (version 2.0.0).

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 huawei.enterprise. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: huawei.enterprise.hw_enterprise_cifs_share_client.

Synopsis

• Create, delete, modify and get the detail of a CIFS Share Client

Requirements

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

• Huawei Dorado v5/v6/v7 and OceanStor v5/v6/v7 Storage

Parameters

Parameter	Comments
custom_vars dictionary	Parameters used to extend those not currently supported by the module. Configuration needs to be based on the REST API documentation for storage. If necessary, you can contact the plugin technical support for assistance.
domain_type string	Domain Type. Choices: "ad_domain_user" "local_user"
filter list / elements=string	Parameter required for all query operations. The response will include the storage parameters that match the indicate filter criteria. Choices: "id" "name" "parent_id" "vstore_id" "vstore_name" "share_name" "permission"
hostname string / required	IP or FQDN of the huawei enterprise management system. MultiIP config as ip1,ip2
id string	CIFS share client unique id, Mutually exclusive with “name”, Priority is higher than name.
name string	CIFS share client unique name, Mutually exclusive with id. Must be a existing User Group name or User name When entering User group name and Everyone add the at sign (@) before the User group name. For example, @group.The name is case insensitive. For AD Domain User and User Group, translate backSlash(\) to double backSlash (\\). For example, ansible\\userGroup. Required when create CIFS share client
parent_id string	ID of the parent object. Required when create CIFS share client. Required when operate by Name
password string / required	The password of the PowerStore host.
permission string	Permission. Required when create CIFS share client. Choices: "read" "full_control" "forbidden" "read_and_write"
socket_timeout integer	Huawei Enterprise Storage rest api Timeout time. Default: 60
state string / required	Define whether the CIFS Share Client should exist or not. Choices: "absent" "present"
storage_port integer	Port number for the Huawei Enterprise array. If not passed, it will take 8088 as default. Default: 8088
use_log boolean	Whether to write plugin log to local filesystem. Choices: false ← (default) true
username string / required	The username of the PowerStore host.
valid_certs string	The path of the SSL certificate variable to specify whether to validate SSL certificate or not. If don’t set means no need to verify ssl cert.
vstore_id string	id of storage vstore. It defaults to 0:SystemVstore if not specified.

Notes

Note

• The check_mode is not supported.

• The modules present in this collection named as ‘huawei.enterprise’ are built to support the Huawei Enterprise Storage System.

Examples

tasks:
  - name: Create CIFS Share Client
    register: cifs_share_client_info
    huawei.enterprise.hw_enterprise_cifs_share_client:
      hostname: "{{ hostname }}"
      username: "{{ username }}"
      password: "{{ password }}"
      valid_certs: "{{ valid_certs }}"
      socket_timeout: "{{ socket_timeout }}"
      storage_port: "{{ storage_port }}"
      use_log: "{{ use_log }}"
      name: "< cifs_share_client_name >"
      parent_id: "< parent_id >"
      permission: "< read | full_control | forbidden | read_and_write >"
      domain_type: "< ad_domain_user | local_user >"
      vstore_id: "< vstore_id >"
      state: "present"

  - name: Modify CIFS Share Client By Name
    register: cifs_share_client_info
    huawei.enterprise.hw_enterprise_cifs_share_client:
      hostname: "{{ hostname }}"
      username: "{{ username }}"
      password: "{{ password }}"
      valid_certs: "{{ valid_certs }}"
      socket_timeout: "{{ socket_timeout }}"
      storage_port: "{{ storage_port }}"
      use_log: "{{ use_log }}"
      name: "< cifs_share_client_name >"
      parent_id: "< parent_id >"
      permission: "< read | full_control | forbidden | read_and_write >"
      vstore_id: "< vstore_id >"
      state: "present"

  - name: Modify CIFS Share Client By Id
    register: cifs_share_client_info
    huawei.enterprise.hw_enterprise_cifs_share_client:
      hostname: "{{ hostname }}"
      username: "{{ username }}"
      password: "{{ password }}"
      valid_certs: "{{ valid_certs }}"
      socket_timeout: "{{ socket_timeout }}"
      storage_port: "{{ storage_port }}"
      use_log: "{{ use_log }}"
      id: "{{ cifs_share_client_info.cifs_share_client_detail.id }}"
      permission: "< read | full_control | forbidden | read_and_write >"
      state: "present"

  - name: Query CIFS Share Client Detail By Name
    register: cifs_share_client_info
    huawei.enterprise.hw_enterprise_cifs_share_client:
      hostname: "{{ hostname }}"
      username: "{{ username }}"
      password: "{{ password }}"
      valid_certs: "{{ valid_certs }}"
      socket_timeout: "{{ socket_timeout }}"
      storage_port: "{{ storage_port }}"
      use_log: "{{ use_log }}"
      name: "< cifs_share_client_name >"
      parent_id: "< parent_id >"
      filter:
        - id
        - name
        - vstore_name
        - vstore_id
        - parent_id
        - share_name
        - permission
      vstore_id: "< vstore_id >"
      state: "present"

  - name: Query CIFS Share Client Detail By Id
    register: cifs_share_client_info
    huawei.enterprise.hw_enterprise_cifs_share_client:
      hostname: "{{ hostname }}"
      username: "{{ username }}"
      password: "{{ password }}"
      valid_certs: "{{ valid_certs }}"
      socket_timeout: "{{ socket_timeout }}"
      storage_port: "{{ storage_port }}"
      use_log: "{{ use_log }}"
      id: "{{ cifs_share_client_info.cifs_share_client_detail.id }}"
      vstore_id: "< vstore_id >"
      filter:
          - id
          - name
          - vstore_name
          - vstore_id
          - parent_id
          - share_name
          - permission
      state: "present"

  - name: Query Multi CIFS Share
    register: all_cifs_share_client
    huawei.enterprise.hw_enterprise_cifs_share_client:
      hostname: "{{ hostname }}"
      username: "{{ username }}"
      password: "{{ password }}"
      valid_certs: "{{ valid_certs }}"
      socket_timeout: "{{ socket_timeout }}"
      storage_port: "{{ storage_port }}"
      use_log: "{{ use_log }}"
      filter:
          - id
          - name
          - vstore_name
          - vstore_id
          - parent_id
          - share_name
          - permission
      vstore_id: "< vstore_id >"
      state: "present"

  - name: Delete CIFS Share Client Detail By Name
    huawei.enterprise.hw_enterprise_cifs_share_client:
      hostname: "{{ hostname }}"
      username: "{{ username }}"
      password: "{{ password }}"
      valid_certs: "{{ valid_certs }}"
      socket_timeout: "{{ socket_timeout }}"
      storage_port: "{{ storage_port }}"
      use_log: "{{ use_log }}"
      name: "< cifs_share_client_name >"
      parent_id: "< parent_id >"
      vstore_id: "< vstore_id >"
      state: "absent"

  - name: Delete CIFS Share Client Detail By Id
    huawei.enterprise.hw_enterprise_cifs_share_client:
      hostname: "{{ hostname }}"
      username: "{{ username }}"
      password: "{{ password }}"
      valid_certs: "{{ valid_certs }}"
      socket_timeout: "{{ socket_timeout }}"
      storage_port: "{{ storage_port }}"
      use_log: "{{ use_log }}"
      id: "{{ cifs_share_client_info.cifs_share_client_detail.id }}"
      vstore_id: "< vstore_id >"
      state: "absent"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
actions list / elements=string	playbook action lists Returned: always Sample: ["create"]
changed boolean	Whether or not the resource has changed. Returned: always Sample: false
cifs_share_client_detail complex	Details of the CIFS Share client. Returned: When CIFS share client exists Sample: {"id": "1", "name": "/sharepath21312", "parent_id": "1", "permission": "full_control", "share_name": "/fs001", "vstore_id": "0", "vstore_name": "System_vStore"}
id string	The system generated ID given to the CIFS Share. Returned: success
name string	Name of the CIFS Share Client. Returned: success
parent_id string	ID of the parent object. Returned: success
permission string	CIFS share permission. Returned: success
share_name string	CIFS share name. Returned: success
vstore_id string	id of storage vstore. Returned: always
vstore_name string	Name of storage vstore. Returned: always
remark string	task execute remark Returned: always Sample: "sample_cifs_share_client create successfully"

Authors

• Huawei eSDK Ansible Team