ciena.mcp.nsi_api_v1_search_equipmentgroups (1.0.4) — module

Install collection

Install with ansible-galaxy collection install ciena.mcp:==1.0.4

Add to requirements.yml

  collections:
    - name: ciena.mcp
      version: 1.0.4

Description

Handle resource of type nsi_api_v1_search_equipmentgroups

Requirements

• python >= 3.6

Inputs

    
id:
    description:
    - (Optional) Comma separated list of Equipment group identifiers to retrieve
    - Used by I(state=['get'])
    type: str

name:
    description:
    - (Optional) Equipment group name
    - Used by I(state=['get'])
    type: str

type:
    description:
    - (Optional) List of Equipment group type
    - Used by I(state=['get'])
    type: str

limit:
    description:
    - The size of a returned page
    - Used by I(state=['get'])
    type: str

state:
    choices:
    - get
    description: []
    type: str

fields:
    description:
    - (Optional) List of comma separated fields to be included in the response. Fields
      require full path (i.e. data.attributes.field)
    - Used by I(state=['get'])
    type: str

offset:
    description:
    - (Optional) Offset for current index of data to return
    - Used by I(state=['get'])
    type: str

sortBy:
    description:
    - (Optional) List of comma separated fields by which to sort the result. Fields require
      full path (i.e. data.attributes.field). A dash or negative sign before a field indicates
      descending order; by default ascending order is used
    - Used by I(state=['get'])
    type: str

include:
    description:
    - '(Optional) List of comma separated resources to be side-loaded. The allowed values
      are: expectations, networkConstructs, discovered, planned'
    - Used by I(state=['get'])
    type: str

subType:
    description:
    - (Optional) List of Equipment group sub type
    - Used by I(state=['get'])
    type: str

endDateMax:
    description:
    - '(Optional) Maximum value of endDate, format is: yyyy-MM-dd''T''HH:mm:ss.SSSZ'
    - Used by I(state=['get'])
    type: str

endDateMin:
    description:
    - '(Optional) Minimum value of endDate, format is: yyyy-MM-dd''T''HH:mm:ss.SSSZ'
    - Used by I(state=['get'])
    type: str

searchText:
    description:
    - (Optional) The searchable text
    - Used by I(state=['get'])
    type: str

equipment.id:
    description:
    - (Optional) Comma separated list of equipment identifiers
    - Used by I(state=['get'])
    type: str

searchFields:
    description:
    - (Optional) List of comma separated fields to search on. If none are specified, all
      supported fields are implied. Fields require full path (e.g. data.attributes.name)
    - Used by I(state=['get'])
    type: str

startDateMax:
    description:
    - '(Optional) Maximum value of startDate, format is: yyyy-MM-dd''T''HH:mm:ss.SSSZ'
    - Used by I(state=['get'])
    type: str

startDateMin:
    description:
    - '(Optional) Minimum value of startDate, format is: yyyy-MM-dd''T''HH:mm:ss.SSSZ'
    - Used by I(state=['get'])
    type: str

resourceState:
    description:
    - '(Optional) List of resource states. By default, if no value for this parameter
      is specified, root and unknown states are filtered out. The allowed values are:
      root, planned, discovered, plannedAndDiscovered, unknown'
    - Used by I(state=['get'])
    type: str

metaDataFields:
    description:
    - '(Optional) List of meta data to be included. The allowed values are: type, subType'
    - Used by I(state=['get'])
    type: str

metaDataQualifiers:
    description:
    - '(Optional) List of meta data options. The allowed values are: absoluteTotals'
    - Used by I(state=['get'])
    type: str

networkConstruct.id:
    description:
    - (Optional) Network Construct identifier
    - Used by I(state=['get'])
    type: str

equipmentGroupExpectations.equipmentIntent.id:
    description:
    - (Optional) Equipment Intent Identifier
    - Used by I(state=['get'])
    type: str