ciena / ciena.mcp / 1.0.4 / module / nsi_api_v1_search_equipment Handle resource of type nsi_api_v1_search_equipment | "added in version" 1.0.0 of ciena.mcp" Authors: unknownciena.mcp.nsi_api_v1_search_equipment (1.0.4) — module
Install with ansible-galaxy collection install ciena.mcp:==1.0.4
collections: - name: ciena.mcp version: 1.0.4
Handle resource of type nsi_api_v1_search_equipment
id: description: - (Optional) List of equipment Ids - Used by I(state=['get']) type: str slot: description: - (Optional) Comma separated list of equipment slots - Used by I(state=['get']) type: str limit: description: - The size of a returned page - Used by I(state=['get']) type: str shelf: description: - (Optional) Comma separated list of equipment shelves - 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 siteId: description: - (Optional) Site Identifier for equipment - 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, planned, discovered, networkConstructs, equipmentPlanned, equipmentDiscovered' - Used by I(state=['get']) type: str subSlot: description: - (Optional) Comma separated list of equipment sub-slots - Used by I(state=['get']) type: str cardType: description: - (Optional) List of Equipment cardType - Used by I(state=['get']) type: str category: description: - '(Optional) List of Equipment category. The allowed values are: rack, shelf, pluggable, standalone' - Used by I(state=['get']) type: str subShelf: description: - (Optional) Comma separated list of equipment sub-shelves - 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 subsubSlot: description: - (Optional) Comma separated list of equipment sub-sub-slots - Used by I(state=['get']) type: str projectName: description: - (Optional) Project name - Used by I(state=['get']) type: str displayState: description: - '(Optional) List of equipment displayState values. The allowed values are: IS, OOS, OOS-AU, OOS-MA, OOS-AUMA' - 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.siteName). If provided, must also provide searchText parameter - 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: specificationMismatch, state, availabilityState, reservationState, maintenanceMode, cardType, category, ncMacAddress, ncSubnetName, projectName, displayAvailabilityState, displayState' - Used by I(state=['get']) type: str neContactState: description: - '(Optional) List of neContactState. The allowed values are: IN, OUT' - Used by I(state=['get']) type: str maintenanceMode: description: - '(Optional) List of Equipment maintenanceMode. The allowed values are: true, false' - Used by I(state=['get']) type: str reservationState: description: - '(Optional) List of Equipment reservationState. The allowed values are: Unknown, Not reserved, Reserved for maintenance, Reserved for facility, Reserved for reversion' - Used by I(state=['get']) type: str availabilityState: description: - '(Optional) List of Equipment availabilityState. The allowed values are: PLANNED, AVAILABLE, UNVALIDATED, INUSE' - 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 networkConstruct.name: description: - (Optional) Network Construct name - Used by I(state=['get']) type: str specificationMismatch: description: - '(Optional) List of Equipment specificationMismatch. The allowed values are: true, false' - Used by I(state=['get']) type: str displayAvailabilityState: description: - '(Optional) List of equipment displayAvailabilityState values. The allowed values are: Planned, Unvalidated, Available, In use' - Used by I(state=['get']) type: str networkConstruct.macAddress: description: - (Optional) Network Construct macAddress - Used by I(state=['get']) type: str networkConstruct.subnetName: description: - (Optional) Network Construct subnetName - Used by I(state=['get']) type: str equipmentExpectations.equipmentIntent.id: description: - (Optional) Equipment Intent Identifier - Used by I(state=['get']) type: str