ciena / ciena.mcp / 1.0.4 / module / nsi_api_equipment Handle resource of type nsi_api_equipment | "added in version" 1.0.0 of ciena.mcp" Authors: unknownciena.mcp.nsi_api_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_equipment
id: description: - (Optional) Comma separated list of equipment identifiers to retrieve - Used by I(state=['get']) type: str data: description: - The equipment data - 'Validate attributes are:' - ' - C(attributes) (dict): The equipment attributes' - ' - C(id) (str): The unique identifier for the equipment resource' - ' - C(meta) (dict): A metadata object that contains non-standard meta information' - ' - C(relationships) (dict): The equipment relationships' - ' - C(type) (str): The equipment resource type' - Used by I(state=['post']) type: dict meta: description: - A metadata object that contains non-standard meta information - 'Validate attributes are:' - ' - C(absoluteTotal) (int): The unfiltered total number of entities in the data' - ' - C(aggregations) (list): The aggregated data based on a requested aggregation name and criteria' - ' - C(filtered) (bool): Flags whether the current object is filtered using `fields` query param or not' - ' - C(missingReferenceIds) (list): The list of missing resource IDs' - ' - C(missingReferences) (bool): boolean detailing if the GET FRE tree has any missing references' - ' - C(total) (int): The total number of entities in the data' - Used by I(state=['post']) type: dict limit: description: - The size of a returned page. Defaulted to return 30 Equipment at once. - Used by I(state=['get']) type: str state: choices: - get - post 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: - Offset for the second page - Used by I(state=['get']) type: str include: description: - '(Optional) List of comma separated resources to be side-loaded. The allowed values are: expectations, equipmentDiscovered, equipmentPlanned' - Used by I(state=['get']) type: str included: description: - Resources related to equipment, such as EquipmentExpectationData - Used by I(state=['post']) type: list networkConstruct.id: description: - (Optional) Network Construct identifier - Used by I(state=['get']) type: str equipmentExpectations.equipmentIntent.id: description: - (Optional) Equipment Intent Identifier - Used by I(state=['get']) type: str