cisco.nd.nd_service_instance (0.5.0) — module

Install collection

Install with ansible-galaxy collection install cisco.nd:==0.5.0

Add to requirements.yml

  collections:
    - name: cisco.nd
      version: 0.5.0

Description

Manages Service Instance of the Nexus Dashboard.

Requirements

• Nexus Dashboard v2.0 or newer

Usage examples

Scanned by Steampunk Spotter

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

- name: Enable a Service Instance
  cisco.nd.nd_service_instance:
    name: "cisco-terraform"
    instance_name: "default"
    target_version: "0.1.15"
    state: enable

Scanned by Steampunk Spotter

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

- name: Upgrade a Service Instance
  cisco.nd.nd_service_instance:
    name: "cisco-terraform"
    instance_name: "default"
    target_version: "0.1.16"
    state: update

Scanned by Steampunk Spotter

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

- name: Restart a Service Instance
  cisco.nd.nd_service_instance:
    name: "cisco-terraform"
    instance_name: "default"
    state: restart

Scanned by Steampunk Spotter

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

- name: Query a Service Instance with name and instance_name
  cisco.nd.nd_service_instance:
    name: "cisco-terraform"
    instance_name: "default"
    state: query
  register: query_result

Scanned by Steampunk Spotter

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

- name: Query all Service Instances
  cisco.nd.nd_service_instance:
    state: query
  register: query_results

Scanned by Steampunk Spotter

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

- name: Disable a Service Instance
  cisco.nd.nd_service_instance:
    name: "cisco-terraform"
    instance_name: "default"
    state: disable

Scanned by Steampunk Spotter

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

- name: Delete an existing service instance
  cisco.nd.nd_service_instance:
    name: "cisco-terraform"
    target_version: "0.1.16"
    state: delete

Inputs

    
host:
    aliases:
    - hostname
    description:
    - IP Address or hostname of the Nexus Dashboard (ND) host.
    - If the value is not specified in the task, the value of environment variable C(ND_HOST)
      will be used instead.
    type: str

name:
    aliases:
    - service_name
    description:
    - The name of the Service.
    type: str

port:
    description:
    - Port number to be used for the REST connection.
    - The default value depends on parameter `use_ssl`.
    - If the value is not specified in the task, the value of environment variable C(ND_PORT)
      will be used instead.
    type: int

state:
    choices:
    - enable
    - query
    - restart
    - update
    - disable
    - delete
    default: enable
    description:
    - Use C(enable) for enabling a Service Instance.
    - Use C(query) for listing all Service Instances.
    - Use C(restart) for restarting a Service Instance.
    - Use C(update) for upgrading a Service Instance.
    - Use C(disable) for disabling a Service Instance.
    - Use C(delete) for deleting a Service Instance.
    type: str

timeout:
    default: 30
    description:
    - The socket level timeout in seconds.
    - If the value is not specified in the task, the value of environment variable C(ND_TIMEOUT)
      will be used instead.
    type: int

use_ssl:
    description:
    - If C(no), an HTTP connection will be used instead of the default HTTPS connection.
    - If the value is not specified in the task, the value of environment variable C(ND_USE_SSL)
      will be used instead.
    type: bool

password:
    description:
    - The password to use for authentication.
    - If the value is not specified in the task, the value of environment variables C(ND_PASSWORD)
      or C(ANSIBLE_NET_PASSWORD) will be used instead.
    type: str

username:
    description:
    - The username to use for authentication.
    - If the value is not specified in the task, the value of environment variables C(ND_USERNAME)
      or C(ANSIBLE_NET_USERNAME) will be used instead.
    type: str

use_proxy:
    description:
    - If C(no), it will not use a proxy, even if one is defined in an environment variable
      on the target hosts.
    - If the value is not specified in the task, the value of environment variable C(ND_USE_PROXY)
      will be used instead.
    type: bool

login_domain:
    description:
    - The login domain name to use for authentication.
    - The default value is DefaultAuth.
    - If the value is not specified in the task, the value of environment variable C(ND_LOGIN_DOMAIN)
      will be used instead.
    type: str

output_level:
    choices:
    - debug
    - info
    - normal
    default: normal
    description:
    - Influence the output of this ND module.
    - C(normal) means the standard output, incl. C(current) dict
    - C(info) adds informational output, incl. C(previous), C(proposed) and C(sent) dicts
    - C(debug) adds debugging output, incl. C(filter_string), C(method), C(response),
      C(status) and C(url) information
    - If the value is not specified in the task, the value of environment variable C(ND_OUTPUT_LEVEL)
      will be used instead.
    type: str

instance_name:
    aliases:
    - service_instance_name
    default: default
    description:
    - The name of the Service Instance.
    type: str

target_version:
    description:
    - The target version of the Service.
    type: str

validate_certs:
    description:
    - If C(no), SSL certificates will not be validated.
    - This should only set to C(no) when used on personally controlled sites using self-signed
      certificates.
    - If the value is not specified in the task, the value of environment variable C(ND_VALIDATE_CERTS)
      will be used instead.
    type: bool