orchestro.orche.childs package

Subpackages

• orchestro.orche.childs.test package
  • Submodules
  • orchestro.orche.childs.test.test_child module
    • test_OrcheChild_cover()
  • orchestro.orche.childs.test.test_group module
    • test_OrcheGroup()
  • orchestro.orche.childs.test.test_orche module
    • test_OrcheChilds()
  • orchestro.orche.childs.test.test_person module
    • test_OrchePerson()
  • orchestro.orche.childs.test.test_subnet module
    • test_OrcheSubnet()
  • orchestro.orche.childs.test.test_system module
    • test_OrcheSystem()
  • Module contents

Submodules

orchestro.orche.childs.child module

Functions and routines associated with Enasis Network Orchestrations.

This file is part of Enasis Network software eco-system. Distribution is permitted, for more information consult the project license file.

class orchestro.orche.childs.child.OrcheChild(orche: Orche, name: str, params: OrcheChildParams)

Bases: object

Parent object for child objects within the project base.

Parameters:

• orche – Primary class instance for Orchestrations.

• name – Name of the object within the Orche config.

• params – Parameters used to instantiate the class.

property ansibout: dict[str, Any]

Return the facts about the attributes from the instance.

Returns:

Facts about the attributes from the instance.

property display: str

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property dumped: dict[str, Any]

Return the facts about the attributes from the instance.

Returns:

Facts about the attributes from the instance.

property enable: bool

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property groups: list[OrcheGroup]

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property kind: OrcheKinds

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property name: str

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property orche: Orche

Return the Orche instance to which the instance belongs.

Returns:

Orche instance to which the instance belongs.

property params: OrcheChildParams

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

validate() → None

Perform advanced validation on the parameters provided.

Note

Works differently than other projects because these children all have one common attribute between them.

orchestro.orche.childs.group module

Functions and routines associated with Enasis Network System Monitor.

This file is part of Enasis Network software eco-system. Distribution is permitted, for more information consult the project license file.

class orchestro.orche.childs.group.OrcheGroup(orche: Orche, name: str, params: OrcheChildParams)

Bases: OrcheChild

Integrate with the Orche routine and perform operations.

property ansible: dict[str, Any] | None

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property dumped: dict[str, Any]

Return the facts about the attributes from the instance.

Returns:

Facts about the attributes from the instance.

property kind: Literal['group']

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property params: OrcheGroupParams

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

property realm: str | None

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

validate() → None

Perform advanced validation on the parameters provided.

Note

Works differently than other projects because these children all have one common attribute between them.

orchestro.orche.childs.orche module

Functions and routines associated with Enasis Network Orchestrations.

This file is part of Enasis Network software eco-system. Distribution is permitted, for more information consult the project license file.

class orchestro.orche.childs.orche.OrcheChilds(orche: Orche)

Bases: object

Contain the object instances for related Orche children.

Parameters:

orche – Primary class instance for Orchestrations.

build_objects() → None

Construct instances using the configuration parameters.

property dumped: dict[str, Any]

Return the facts about the attributes from the instance.

Returns:

Facts about the attributes from the instance.

property groups: dict[str, OrcheGroup]

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property persons: dict[str, OrchePerson]

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property subnets: dict[str, OrcheSubnet]

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property systems: dict[str, OrcheSystem]

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

validate() → None

Perform advanced validation on the parameters provided.

orchestro.orche.childs.person module

Functions and routines associated with Enasis Network System Monitor.

This file is part of Enasis Network software eco-system. Distribution is permitted, for more information consult the project license file.

class orchestro.orche.childs.person.OrchePerson(orche: Orche, name: str, params: OrcheChildParams)

Bases: OrcheChild

Contain the properties regarding the actual user person.

property display: str

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property domain: str | None

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property dumped: dict[str, Any]

Return the facts about the attributes from the instance.

Returns:

Facts about the attributes from the instance.

property fqdn: str

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property kind: Literal['person']

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property params: OrchePersonParams

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

property realm: str | None

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

validate() → None

Perform advanced validation on the parameters provided.

Note

Works differently than other projects because these children all have one common attribute between them.

orchestro.orche.childs.subnet module

Functions and routines associated with Enasis Network System Monitor.

This file is part of Enasis Network software eco-system. Distribution is permitted, for more information consult the project license file.

class orchestro.orche.childs.subnet.OrcheSubnet(orche: Orche, name: str, params: OrcheChildParams)

Bases: OrcheChild

Integrate with the Orche routine and perform operations.

property kind: Literal['subnet']

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property params: OrcheSubnetParams

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

validate() → None

Perform advanced validation on the parameters provided.

Note

Works differently than other projects because these children all have one common attribute between them.

orchestro.orche.childs.system module

Functions and routines associated with Enasis Network System Monitor.

This file is part of Enasis Network software eco-system. Distribution is permitted, for more information consult the project license file.

class orchestro.orche.childs.system.OrcheSystem(orche: Orche, name: str, params: OrcheChildParams)

Bases: OrcheChild

Integrate with the Orche routine and perform operations.

property ansible: dict[str, Any] | None

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property domain: str | None

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property dumped: dict[str, Any]

Return the facts about the attributes from the instance.

Returns:

Facts about the attributes from the instance.

property fqdn: str

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property kind: Literal['system']

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property params: OrcheSystemParams

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

property realm: str | None

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

validate() → None

Perform advanced validation on the parameters provided.

Note

Works differently than other projects because these children all have one common attribute between them.

Module contents

Functions and routines associated with Enasis Network Orchestrations.

This file is part of Enasis Network software eco-system. Distribution is permitted, for more information consult the project license file.

class orchestro.orche.childs.OrcheChild(orche: Orche, name: str, params: OrcheChildParams)

Bases: object

Parent object for child objects within the project base.

Parameters:

• orche – Primary class instance for Orchestrations.

• name – Name of the object within the Orche config.

• params – Parameters used to instantiate the class.

property ansibout: dict[str, Any]

Return the facts about the attributes from the instance.

Returns:

Facts about the attributes from the instance.

property display: str

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property dumped: dict[str, Any]

Return the facts about the attributes from the instance.

Returns:

Facts about the attributes from the instance.

property enable: bool

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property groups: list[OrcheGroup]

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property kind: OrcheKinds

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property name: str

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property orche: Orche

Return the Orche instance to which the instance belongs.

Returns:

Orche instance to which the instance belongs.

property params: OrcheChildParams

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

validate() → None

Perform advanced validation on the parameters provided.

Note

Works differently than other projects because these children all have one common attribute between them.

class orchestro.orche.childs.OrcheChilds(orche: Orche)

Bases: object

Contain the object instances for related Orche children.

Parameters:

orche – Primary class instance for Orchestrations.

build_objects() → None

Construct instances using the configuration parameters.

property dumped: dict[str, Any]

Return the facts about the attributes from the instance.

Returns:

Facts about the attributes from the instance.

property groups: dict[str, OrcheGroup]

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property persons: dict[str, OrchePerson]

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property subnets: dict[str, OrcheSubnet]

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property systems: dict[str, OrcheSystem]

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

validate() → None

Perform advanced validation on the parameters provided.

class orchestro.orche.childs.OrcheGroup(orche: Orche, name: str, params: OrcheChildParams)

Bases: OrcheChild

Integrate with the Orche routine and perform operations.

property ansible: dict[str, Any] | None

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property dumped: dict[str, Any]

Return the facts about the attributes from the instance.

Returns:

Facts about the attributes from the instance.

property kind: Literal['group']

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property params: OrcheGroupParams

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

property realm: str | None

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

validate() → None

Perform advanced validation on the parameters provided.

Note

Works differently than other projects because these children all have one common attribute between them.

class orchestro.orche.childs.OrchePerson(orche: Orche, name: str, params: OrcheChildParams)

Bases: OrcheChild

Contain the properties regarding the actual user person.

property display: str

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property domain: str | None

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property dumped: dict[str, Any]

Return the facts about the attributes from the instance.

Returns:

Facts about the attributes from the instance.

property fqdn: str

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property kind: Literal['person']

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property params: OrchePersonParams

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

property realm: str | None

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

validate() → None

Perform advanced validation on the parameters provided.

Note

Works differently than other projects because these children all have one common attribute between them.

class orchestro.orche.childs.OrcheSubnet(orche: Orche, name: str, params: OrcheChildParams)

Bases: OrcheChild

Integrate with the Orche routine and perform operations.

property kind: Literal['subnet']

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property params: OrcheSubnetParams

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

validate() → None

Perform advanced validation on the parameters provided.

Note

Works differently than other projects because these children all have one common attribute between them.

class orchestro.orche.childs.OrcheSystem(orche: Orche, name: str, params: OrcheChildParams)

Bases: OrcheChild

Integrate with the Orche routine and perform operations.

property ansible: dict[str, Any] | None

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property domain: str | None

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property dumped: dict[str, Any]

Return the facts about the attributes from the instance.

Returns:

Facts about the attributes from the instance.

property fqdn: str

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property kind: Literal['system']

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property params: OrcheSystemParams

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

property realm: str | None

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

validate() → None

Perform advanced validation on the parameters provided.

Note

Works differently than other projects because these children all have one common attribute between them.