netautomate.netorca.get_service_items module

Module Documentation: get_service_items.yml

Table of Contents

Module: get_service_items

short_description: Get Service Items form NetOrca

version_added: 0.1.0

description: This modules gets 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 team. If this is not specified, username and password need to be provided.
    • required: false
    • type: str
  • username:
    • description: Username for account in the team. Use when no API KEY is available.
    • required: false
    • type: str
  • password:
    • description: Password for account in the team. Use when no API KEY is available.
    • required: false
    • type: str
  • filters:
    • description: Filters to apply to the change instances. See NetOrca API documentation for more details.
    • required: false
    • type: dict

extends_documentation_fragment:

  • netautomate.netorca.get_service_items

author:

  • Scott Rowlandson

Examples

# Supply API Key and get all changes
- name: Get all service items
  get_service_items:
    url: https://app.netorca.io
    api_key: <api key here>
    service_name: LoadBalancer

Return Values

# These are examples of possible return values, and in general should use other names for return values.
service_items:
    description: An array of all the instances of that service
    type: array
    returned: always
message:
    description: A general message, useful when errors are encountered
    type: str
    returned: always
    sample: 'Returned 10 items'

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