cisco.dnac.global_credential_http_read (2.0.7) — module

Install collection

Install with ansible-galaxy collection install cisco.dnac:==2.0.7

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 2.0.7

Description

Adds HTTP read credentials.

Updates global HTTP Read credential.

Requirements

• dnacentersdk

Usage examples

Scanned by Steampunk Spotter

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

- name: create_http_read_credentials
  cisco.dnac.global_credential_http_read:
    state: create  # required
    payload:  # required
    - password: SomeValue  # string, required
      port: 1  #  integer, required
      username: SomeValue  # string, required
      comments: SomeValue  # string
      credentialType: SomeValue  # string
      description: SomeValue  # string
      id: SomeValue  # string
      instanceTenantId: SomeValue  # string
      instanceUuid: SomeValue  # string
      secure: True  # boolean

Scanned by Steampunk Spotter

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

- name: update_http_read_credential
  cisco.dnac.global_credential_http_read:
    state: update  # required
    password: SomeValue  # string, required
    port: 1  #  integer, required
    username: SomeValue  # string, required
    comments: SomeValue  # string
    credentialType: # valid values are 'GLOBAL',
      # 'APP'.
      SomeValue  # string
    description: SomeValue  # string
    id: SomeValue  # string
    instanceTenantId: SomeValue  # string
    instanceUuid: SomeValue  # string
    secure: True  # boolean

Inputs

    
id:
    description:
    - HTTPReadCredentialDTO's id.
    type: str

port:
    description:
    - HTTPReadCredentialDTO's port.
    - Required for state update.
    type: int

secure:
    description:
    - HTTPReadCredentialDTO's secure.
    type: bool

payload:
    description:
    - An object to send in the Request body.
    - Required for state create.
    elements: dict
    suboptions:
      comments:
        description:
        - It is the global credential http read's comments.
        type: str
      credentialType:
        description:
        - It is the global credential http read's credentialType.
        type: str
      description:
        description:
        - It is the global credential http read's description.
        type: str
      id:
        description:
        - It is the global credential http read's id.
        type: str
      instanceTenantId:
        description:
        - It is the global credential http read's instanceTenantId.
        type: str
      instanceUuid:
        description:
        - It is the global credential http read's instanceUuid.
        type: str
      password:
        description:
        - It is the global credential http read's password.
        required: true
        type: str
      port:
        description:
        - It is the global credential http read's port.
        required: true
        type: int
      secure:
        description:
        - It is the global credential http read's secure.
        type: bool
      username:
        description:
        - It is the global credential http read's username.
        required: true
        type: str
    type: list

comments:
    description:
    - HTTPReadCredentialDTO's comments.
    type: str

password:
    description:
    - HTTPReadCredentialDTO's password.
    - Required for state update.
    type: str

username:
    description:
    - HTTPReadCredentialDTO's username.
    - Required for state update.
    type: str

description:
    description:
    - HTTPReadCredentialDTO's description.
    type: str

instanceUuid:
    description:
    - HTTPReadCredentialDTO's instanceUuid.
    type: str

credentialType:
    description:
    - HTTPReadCredentialDTO's credentialType.
    - Available values are 'GLOBAL' and 'APP'.
    type: str

instanceTenantId:
    description:
    - HTTPReadCredentialDTO's instanceTenantId.
    type: str

Outputs

dnac_response:
  description: A dictionary with the response returned by the DNA Center Python SDK
  returned: always
  sample:
    response: 29
    version: '1.0'
  type: dict
missing_params:
  description: Provided arguments do not comply with the schema of the DNA Center
    Python SDK function
  returned: when the function request schema is not satisfied
  sample: null
  type: list
sdk_function:
  description: The DNA Center SDK function used to execute the task
  returned: always
  sample: discovery.create_http_read_credentials
  type: str

See also

• cisco.dnac.plugins.module_utils.definitions.global_credential_http_read
• GlobalCredentialHttpRead reference: Complete reference of the GlobalCredentialHttpRead object model. link
• GlobalCredentialHttpRead reference: SDK reference. link