Try SpotterHandle resource of type nsi_api_search_networkconstructs
| "added in version" 1.0.0 of ciena.mcp"
Authors: unknown
Install with ansible-galaxy collection install ciena.mcp:==1.0.4
collections:
- name: ciena.mcp
version: 1.0.4Handle resource of type nsi_api_search_networkconstructs
id:
description:
- (Optional) List of networkConstruct Ids
- Used by I(state=['get'])
type: str
name:
description:
- (Optional) List of device name values
- Used by I(state=['get'])
type: str
tags:
description:
- (Optional) Allow filtering on NC tags. This parameter accepts a list of comma separated
strings
- 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, physicalLocation, parentNetworkConstruct, networkConstructDiscovered,
networkConstructPlanned'
- Used by I(state=['get'])
type: str
concrete:
description:
- (Optional) Id of the concrete networkConstruct
- Used by I(state=['get'])
type: str
slteType:
description:
- '(Optional) slteType parameter used to filter results. The allowed values are:
SLTE'
- Used by I(state=['get'])
type: str
ipAddress:
description:
- (Optional) Ip Address of Network Construct
- Used by I(state=['get'])
type: str
modelType:
description:
- (Optional) modelType parameter used to filter results
- Used by I(state=['get'])
type: str
sessionId:
description:
- (Optional) List of Management Session Ids
- Used by I(state=['get'])
type: str
syncState:
description:
- '(Optional) List of networkConstruct syncStates. The allowed values are: notSynchronized,
synchronizing, synchronized, failed, aborted, deleting, deleteFailed'
- Used by I(state=['get'])
type: str
typeGroup:
description:
- (Optional) List of networkConstruct typeGroups
- 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
macAddress:
description:
- (Optional) macAddress parameter used to filter results
- Used by I(state=['get'])
type: str
namedQuery:
description:
- '(Optional) Comma-separated named query id list; The allowed values are: OADMCapabilityNodes,
OADMCapabilityNodesV2'
- Used by I(state=['get'])
type: str
searchText:
description:
- (Optional) The searchable text
- Used by I(state=['get'])
type: str
subnetName:
description:
- (Optional) The subnet name list
- Used by I(state=['get'])
type: str
displayName:
description:
- (Optional) List of device displayName values
- Used by I(state=['get'])
type: str
resourceType:
description:
- (Optional) List of networkConstruct resourceTypes
- Used by I(state=['get'])
type: str
rrConfigured:
choices:
- 'false'
- 'true'
description:
- (Optional) List of networkConstruct based on BGP RRConfiguration.
- 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
identifierKey:
description:
- The identifier key list
- Used by I(state=['get'])
type: list
resourceState:
description:
- '(Optional) List of networkConstruct planning 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: resourceType,
associationState, syncState, networkConstructType, resourceState, softwareVersion,
displaySyncState, displayResourceState, displayAssociationState, tags, subnetName,
associationStateQualifier, resourcePartitionInfo'
- Used by I(state=['get'])
type: str
identifierValue:
description:
- The identifier value list
- Used by I(state=['get'])
type: list
softwareVersion:
description:
- (Optional) List of networkConstruct software versions
- Used by I(state=['get'])
type: str
associationState:
description:
- '(Optional) List of networkConstruct associationStates. The allowed values are:
GOA, LOA'
- Used by I(state=['get'])
type: str
displaySyncState:
description:
- '(Optional) List of networkConstruct syncStates. The allowed values are: planned,
notSynchronized, synchronizing, synchronized, failed, pending, deleting'
- Used by I(state=['get'])
type: str
geoDistanceQuery:
description:
- '(Optional) Filters on distance from a specified location; the Geo distance query
is formatted as follows: <distance>:<latitude>:<longitude>'
- 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
physicalLocationId:
description:
- (Optional) Physical location id
- Used by I(state=['get'])
type: str
displayResourceState:
description:
- '(Optional) List of networkConstruct resourceStates. The allowed values are: root,
planned, discovered, unknown'
- Used by I(state=['get'])
type: str
networkConstructType:
description:
- '(Optional) List of Network Construct types. The allowed values are: networkElement,
shelf, osrpNode'
- Used by I(state=['get'])
type: str
resourcePartitionInfo:
description:
- (Optional) List of resourcePartitionInfo
- Used by I(state=['get'])
type: str
displayAssociationState:
description:
- '(Optional) List of networkConstruct associationStates. The allowed values are:
Connected, Not connected'
- Used by I(state=['get'])
type: str
associationStateQualifier:
description:
- '(Optional) Association state qualifier. The allowed values are: MANUAL, SYSTEM,
NETWORK'
- Used by I(state=['get'])
type: str
displayInventorySyncFailureReason:
description:
- (Optional) List of networkConstruct inventory sync failure reasons.
- Used by I(state=['get'])
type: str
networkConstructExpectations.serviceIntent.id:
description:
- (Optional) The service intent Id
- Used by I(state=['get'])
type: str
networkConstructExpectations.equipmentIntent.id:
description:
- (Optional) The equipment intent Id
- Used by I(state=['get'])
type: str