ciena.mdso.resources_by_resourceid_observed (1.1.6) — module

Handle resource of type resources_by_resourceid_observed

| "added in version" 1.0.0 of ciena.mdso"

Authors: unknown

Install collection

Install with ansible-galaxy collection install ciena.mdso:==1.1.6


Add to requirements.yml

  collections:
    - name: ciena.mdso
      version: 1.1.6

Description

Handle resource of type resources_by_resourceid_observed


Requirements

Inputs

    
id:
    description:
    - Unique identifier for the resource (optional/ignored on calls to create)
    - Used by I(state=['patch', 'put'])
    type: str

tags:
    description:
    - Tags
    - Used by I(state=['patch', 'put'])
    type: dict

label:
    description:
    - Textual label
    - Used by I(state=['patch', 'put'])
    type: str

state:
    choices:
    - get
    - head
    - patch
    - put
    description: []
    type: str

reason:
    description:
    - Reason for the orchestration state
    - Used by I(state=['patch', 'put'])
    type: str

shared:
    description:
    - Is resource shared?
    - Used by I(state=['patch', 'put'])
    type: bool

orderId:
    description:
    - If applicable, the order containing this resource
    - Used by I(state=['patch', 'put'])
    type: str

revision:
    description:
    - Strictly increasing revision number, incremented every update including observed
      update
    - Used by I(state=['patch'])
    type: int

tenantId:
    description:
    - Owner tenant of the resource?
    - Used by I(state=['patch', 'put'])
    type: str

validate:
    description:
    - Whether to perform custom validation in addition to built-in schema and accessor
      validations
    - Used by I(state=['patch', 'put'])
    type: bool

autoClean:
    description:
    - Free up any resources automatically upon any activation failure
    - Used by I(state=['patch', 'put'])
    type: bool

createdAt:
    description:
    - Time of creation
    - Used by I(state=['patch'])
    type: str

obfuscate:
    description:
    - If true, schema obfuscated values will be replaced with a fixed string in the response.
    - Used by I(state=['get', 'head', 'patch', 'put'])
    type: bool

orchState:
    description:
    - Current state of the resource in the orchestrator
    - Used by I(state=['patch', 'put'])
    type: str

productId:
    description:
    - The type of product for this resource
    - Used by I(state=['patch', 'put'])
    type: str

updatedAt:
    description:
    - Time of last update
    - Used by I(state=['patch'])
    type: str

discovered:
    description:
    - Is this resource discovered
    - Used by I(state=['patch'])
    type: bool

properties:
    description:
    - Properties
    - 'Validate attributes are:'
    - ' - C(obj) (list): '
    - Used by I(state=['patch', 'put'])
    type: dict

resourceId:
    description:
    - Identifier of the resource to update
    - Required with I(state=['get', 'head', 'patch', 'put'])
    - Used by I(state=['get', 'head', 'patch', 'put'])
    type: str

description:
    description:
    - Detailed description of this resource
    - Used by I(state=['patch', 'put'])
    type: str

differences:
    description:
    - Differences represent the difference between desired and observed state
    - Used by I(state=['patch', 'put'])
    type: list

nativeState:
    description:
    - Native (type specific) state
    - Used by I(state=['patch', 'put'])
    type: str

subDomainId:
    description:
    - Identifier of the resource's sub-domain
    - Used by I(state=['patch', 'put'])
    type: str

updateCount:
    description:
    - Monotonically increasing count of updates applied to this resource
    - Used by I(state=['patch'])
    type: int

updateState:
    description:
    - Current state of updating the resource, or `unset`
    - Used by I(state=['patch'])
    type: str

providerData:
    description:
    - Provider custom data
    - 'Validate attributes are:'
    - ' - C(obj) (list): '
    - Used by I(state=['patch', 'put'])
    type: dict

updateReason:
    description:
    - Reason for the update state
    - Used by I(state=['patch'])
    type: str

resourceTypeId:
    description:
    - The type of this resource
    - Used by I(state=['patch', 'put'])
    type: str

desiredOrchState:
    description:
    - Desired orchestration state
    - Used by I(state=['patch', 'put'])
    type: str

providerResourceId:
    description:
    - Identifier of the resource in provider's context
    - Used by I(state=['patch', 'put'])
    type: str

sharingPermissionId:
    description:
    - The sharing permission associated with the resource
    - Used by I(state=['patch', 'put'])
    type: str