ciena.mcp.resource_providers (1.0.4) — module

Handle resource of type resource_providers

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

Authors: unknown

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 resource_providers


Requirements

Inputs

    
q:
    description:
    - Optional query parameter to define a query filter using property:value syntax
    - Used by I(state=['get', 'head'])
    type: str

id:
    description:
    - Unique identifier to address the resource provider
    - Used by I(state=['post'])
    type: str

uri:
    description:
    - Address to contact the resource provider
    - Used by I(state=['post'])
    type: str

limit:
    description:
    - The maximum number of elements to return in a single paged request
    - Used by I(state=['get', 'head'])
    type: int

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

title:
    description:
    - Name of the resource provider
    - Used by I(state=['post'])
    type: str

offset:
    description:
    - Requested offset within the total result set to be the first element in the paged
      response
    - Used by I(state=['get', 'head'])
    type: int

pageToken:
    description:
    - String pagination token returned from a previous query that encodes query information
      in order to optimize a
    - subsequent request for a page of results. The token includes the limit and offset
      parameters for the next page, but one or
    - both can be included to override the encoded values
    - Used by I(state=['get', 'head'])
    type: str

domainType:
    description:
    - Type of domain managed by the resource provider
    - Used by I(state=['post'])
    type: str

properties:
    description:
    - Properties of the resource provider
    - 'Validate attributes are:'
    - ' - C(obj) (list): '
    - Used by I(state=['post'])
    type: dict

providerId:
    description:
    - Identifier of the resource provider in provider's context
    - Used by I(state=['post'])
    type: str

description:
    description:
    - Description of the resource provider
    - Used by I(state=['post'])
    type: str

relationships:
    description:
    - Settings to declare how relationships should be identified for resource types managed
      by this resource provider
    - Used by I(state=['post'])
    type: list

resourceTypes:
    description:
    - List of resource types managed by the resource provider
    - Used by I(state=['post'])
    type: list

domainSettings:
    description:
    - Domain level setting for the resource provider
    - 'Validate attributes are:'
    - ' - C(asyncDeviceTypes) (list): Specifies the Resource Type IDs that use async discovery
      strategy'
    - ' - C(connection_status) (bool): Specifies if maintenance of domain''s connection
      status is supported'
    - ' - C(initial_discovery_status) (bool): Specifies if maintenance of domain''s initial
      discovery status is supported'
    - ' - C(metaInfoDiscoveryStrategy) (dict): Specifies the Domain meta information polling
      strategy'
    - ' - C(minInterUpsertIntervalMs) (number): Specifies the minimal inter-call interval
      bpocore should honor when upserting the Domain'
    - ' - C(rpType) (dict): Specifies the RP Type'
    - Used by I(state=['post'])
    type: dict

lastUpsertTime:
    description:
    - Last time the resource provider is upserted in the database
    - Used by I(state=['post'])
    type: str

protocolVersion:
    description:
    - Identifies the protocol version supported by the resource provider
    - Used by I(state=['post'])
    type: str

asyncProtocolVersion:
    description:
    - Identifies the async protocol version supported by the resource provider
    - Used by I(state=['post'])
    type: str