netautomate.netorca.update_change_instances module

Module Documentation: update_change_instances

Table of Contents

Module: update_change_instances

short_description: Update Change Instances in NetOrca

version_added: 0.1.0

description: This module updates the change instances for a team in NetOrca.

options:

  • url:
    • description: Base URL for NetOrca.
    • required: true
    • type: str
  • api_key:
    • description: API Key generated for the team. If this is not specified, username and password need to be provided.
    • required: false
    • type: str
  • username:
    • description: Username for the account in the team. Use when no API KEY is available.
    • required: false
    • type: str
  • password:
    • description: Password for the account in the team. Use when no API KEY is available.
    • required: false
    • type: str
  • uuid:
    • description: The ID of the change instance to update.
    • required: false
    • type: str
  • state:
    • description: One of 'PENDING', 'ACCEPTED', 'COMPLETED'.
    • required: false
    • type: str

extends_documentation_fragment:

  • netautomate.netorca.update_change_instances

author:

  • Scott Rowlandson

Examples

# Supply API Key and update change instance
- name: Update change instance
  update_change_instances:
    url: https://app.netorca.io
    api_key: <api key here>
    uuid: <change instance ID here>
    state: ACCEPTED

# Supply credentials and update change instance
- name: Update change instance
  netorca_update_changes:
    url: https://app.netorca.io
    username: team_member_a
    password: super_secure_password_here
    uuid: <change instance ID here>
    state: COMPLETED

Return Values

# These are examples of possible return values, and in general, should use other names for return values.
updated_change_instances:
    description: The change instance returned by NetOrca.
    type: list
    returned: always
message:
    description: A general message, useful when errors are encountered.
    type: str
    returned: always
    sample: 'Updated change instance successfully'

File a bug with the netautomate.netorca collection in order to have it corrected.