Module transportpce

  • License: ASL 2.0

  • Version: 0.0.2

Entities

entity transportpce::Service

Parents: transportpce::base::ResourceABC

attribute string? common_id=null
attribute string? connection_type=null
attribute string service_name
Rel hard_constraints:
rel service_a_end:
rel service_resiliency:
rel service_z_end:

relation transportpce::service::HardConstraints hard_constraints [0:1]
relation transportpce::service::ServiceEndpoint service_a_end [0:1]
relation transportpce::service::ServiceResiliency service_resiliency [0:1]
relation transportpce::service::ServiceEndpoint service_z_end [0:1]

The following implements statements select implementations for this entity:

entity transportpce::base::Api

Parents: std::Entity

Entity representing the api where some transportpce resources can be deployed.

attribute string url

The url of the api where the resources should be deployed

attribute string? agent_name=null

An optional string to use as agent name for all api resources.

attribute string? username=null

The username to use to authenticate to the api

attribute string? password=null

The password to use to authenticate to the api

attribute bool auto_agent=true

Whether the agent config should be automatically created based on this entity’s attributes.

relation std::AgentConfig agent_config [1]

The agent config, the relation is set automatically when auto_agent is true, otherwise it has to be provided.

The following implementations are defined for this entity:

The following implements statements select implementations for this entity:

entity transportpce::base::ResourceABC

Parents: std::PurgeableResource, std::ManagedResource

Base resource for all the resource defined in this module.

relation transportpce::base::Api api [1]

The api where the resource should be deployed.

entity transportpce::base::ServiceStatus

Parents: transportpce::base::ResourceABC

This resource can be used to wait for a service to reach a desired status. The resource will be skipped as long as the desired status is not reached.

attribute string operational_state

The operational state to wait for

relation transportpce::Service service [1]

The service we want to wait for.

The following implements statements select implementations for this entity:

entity transportpce::service::HardConstraints

Parents: std::Entity

Rel exclude:

Rel include:

relation transportpce::service::hard_constraints::Exclude exclude [0:1]
relation transportpce::service::hard_constraints::Include include [0:1]

The following implements statements select implementations for this entity:

entity transportpce::service::ServiceEndpoint

Parents: std::Entity

attribute string? clli=null
attribute string? node_id=null
attribute string? optic_type=null
attribute string? service_format=null
attribute int? service_rate=null
Rel rx_direction:
rel tx_direction:

relation transportpce::service::service_endpoint::RxDirection rx_direction [0:*]
relation transportpce::service::service_endpoint::TxDirection tx_direction [0:*]

The following implements statements select implementations for this entity:

entity transportpce::service::ServicePort

Parents: std::Entity

From the device model perspective the port-device-name plus the port-circuit-pack-name plus the port-name uniquely identifies the port. From the network model perspective the openroadm-topology-ref plus port-device-name plus port-name uniquely identify the termination point in the network model.

attribute string? port_circuit_pack_name=null
attribute string? port_circuit_pack_type=null
attribute string? port_device_name=null
attribute string? port_name=null
attribute string? port_rack=null
attribute string? port_shelf=null
attribute string? port_slot=null
attribute string? port_sub_slot=null
attribute string? port_type=null

The following implements statements select implementations for this entity:

entity transportpce::service::ServiceResiliency

Parents: std::Entity

attribute string? resiliency=null

The following implements statements select implementations for this entity:

entity transportpce::service::hard_constraints::Exclude

Parents: std::Entity

attribute string[]? node_id=null
attribute string[]? site=null

The following implements statements select implementations for this entity:

entity transportpce::service::hard_constraints::Include

Parents: std::Entity

attribute string[]? node_id=null
attribute string[]? site=null

The following implements statements select implementations for this entity:

entity transportpce::service::service_endpoint::RxDirection

Parents: std::Entity

attribute int? x_index=null
Rel port:

relation transportpce::service::ServicePort port [0:1]

The following implements statements select implementations for this entity:

entity transportpce::service::service_endpoint::TxDirection

Parents: std::Entity

attribute int? x_index=null
Rel port:

relation transportpce::service::ServicePort port [0:1]

The following implements statements select implementations for this entity:

Implementations

implementation transportpce::base::api_agent

Plugins

transportpce.get_network(api: 'transportpce::base::Api', *, name: 'string') → 'dict'

Get the network with the given name, return an Unknown if it can’t be found.

transportpce.get_service(api: 'transportpce::base::Api', *, name: 'string') → 'dict'

Try to get the service with the given name, return an Unknown if it can’t be found.

Resources

class transportpce.service.ServiceResource
class transportpce.service.ServiceStatusResource

Handlers

class transportpce.service.ServiceHandler
class transportpce.service.ServiceStatusHandler