racampos.dnac.file_namespace (0.0.1) — module

Manage FileNamespace objects of File

| "added in version" 1.0 of racampos.dnac"

Authors: first last (@GitHubID)

preview | supported by community

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install racampos.dnac:==0.0.1


Add to requirements.yml

  collections:
    - name: racampos.dnac
      version: 0.0.1

Description

Returns list of available namespaces.

Returns list of files under a specific namespace.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: get_list_of_available_namespaces
  cisco.dnac.file_namespace:
    state: query  # required

  register: query_result
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  
- name: get_list_of_files
  cisco.dnac.file_namespace:
    state: query  # required
    name_space: SomeValue  # string, required
  register: query_result

Inputs

    
name_space:
    description:
    - A listing of fileId's.
    required: true
    type: str

Outputs

get_list_of_available_namespaces:
  contains: null
  description: Returns list of available namespaces.
  response:
    description: Response, property of the response body (list of strings).
    returned: always
    type: list
  returned: always
  type: dict
  version:
    description: Version, property of the response body.
    returned: always
    sample: '1.0'
    type: str
get_list_of_files:
  contains: null
  description: Returns list of files under a specific namespace.
  response:
    contains:
      attributeInfo:
        description: It is the file namespace's attributeInfo.
        returned: always
        type: dict
      downloadPath:
        description: It is the file namespace's downloadPath.
        returned: always
        sample: <downloadpath>
        type: str
      encrypted:
        description: It is the file namespace's encrypted.
        returned: always
        sample: false
        type: bool
      fileFormat:
        description: It is the file namespace's fileFormat.
        returned: always
        sample: <fileformat>
        type: str
      fileSize:
        description: It is the file namespace's fileSize.
        returned: always
        sample: <filesize>
        type: str
      id:
        description: It is the file namespace's id.
        returned: always
        sample: '478012'
        type: str
      md5Checksum:
        description: It is the file namespace's md5Checksum.
        returned: always
        sample: <md5checksum>
        type: str
      name:
        description: It is the file namespace's name.
        returned: always
        sample: <name>
        type: str
      nameSpace:
        description: It is the file namespace's nameSpace.
        returned: always
        sample: <namespace>
        type: str
      sftpServerList:
        description: It is the file namespace's sftpServerList.
        returned: always
        type: list
      sha1Checksum:
        description: It is the file namespace's sha1Checksum.
        returned: always
        sample: <sha1checksum>
        type: str
      taskId:
        description: It is the file namespace's taskId.
        returned: always
        type: dict
    description: Response, property of the response body (list of objects).
    returned: always
    type: list
  returned: always
  type: dict
  version:
    description: Version, property of the response body.
    returned: always
    sample: '1.0'
    type: str

See also