orchestro.orche package

Subpackages

• orchestro.orche.addons package
  • Subpackages
    • orchestro.orche.addons.test package
      • Submodules
      • orchestro.orche.addons.test.test_logger module
      • Module contents
  • Submodules
  • orchestro.orche.addons.logger module
    • OrcheLogger
      • OrcheLogger.log()
      • OrcheLogger.log_c()
      • OrcheLogger.log_d()
      • OrcheLogger.log_e()
      • OrcheLogger.log_i()
      • OrcheLogger.log_w()
      • OrcheLogger.start()
      • OrcheLogger.stop()
  • Module contents
    • OrcheLogger
      • OrcheLogger.log()
      • OrcheLogger.log_c()
      • OrcheLogger.log_d()
      • OrcheLogger.log_e()
      • OrcheLogger.log_i()
      • OrcheLogger.log_w()
      • OrcheLogger.start()
      • OrcheLogger.stop()
• orchestro.orche.childs package
  • Subpackages
    • orchestro.orche.childs.test package
      • Submodules
      • orchestro.orche.childs.test.test_child module
      • orchestro.orche.childs.test.test_group module
      • orchestro.orche.childs.test.test_orche module
      • orchestro.orche.childs.test.test_person module
      • orchestro.orche.childs.test.test_subnet module
      • orchestro.orche.childs.test.test_system module
      • Module contents
  • Submodules
  • orchestro.orche.childs.child module
    • OrcheChild
      • OrcheChild.ansibout
      • OrcheChild.display
      • OrcheChild.dumped
      • OrcheChild.enable
      • OrcheChild.groups
      • OrcheChild.kind
      • OrcheChild.name
      • OrcheChild.orche
      • OrcheChild.params
      • OrcheChild.validate()
  • orchestro.orche.childs.group module
    • OrcheGroup
      • OrcheGroup.ansible
      • OrcheGroup.dumped
      • OrcheGroup.kind
      • OrcheGroup.params
      • OrcheGroup.realm
      • OrcheGroup.validate()
  • orchestro.orche.childs.orche module
    • OrcheChilds
      • OrcheChilds.build_objects()
      • OrcheChilds.dumped
      • OrcheChilds.groups
      • OrcheChilds.persons
      • OrcheChilds.subnets
      • OrcheChilds.systems
      • OrcheChilds.validate()
  • orchestro.orche.childs.person module
    • OrchePerson
      • OrchePerson.display
      • OrchePerson.domain
      • OrchePerson.dumped
      • OrchePerson.fqdn
      • OrchePerson.kind
      • OrchePerson.params
      • OrchePerson.realm
      • OrchePerson.validate()
  • orchestro.orche.childs.subnet module
    • OrcheSubnet
      • OrcheSubnet.kind
      • OrcheSubnet.params
      • OrcheSubnet.validate()
  • orchestro.orche.childs.system module
    • OrcheSystem
      • OrcheSystem.ansible
      • OrcheSystem.domain
      • OrcheSystem.dumped
      • OrcheSystem.fqdn
      • OrcheSystem.kind
      • OrcheSystem.params
      • OrcheSystem.realm
      • OrcheSystem.validate()
  • Module contents
    • OrcheChild
      • OrcheChild.ansibout
      • OrcheChild.display
      • OrcheChild.dumped
      • OrcheChild.enable
      • OrcheChild.groups
      • OrcheChild.kind
      • OrcheChild.name
      • OrcheChild.orche
      • OrcheChild.params
      • OrcheChild.validate()
    • OrcheChilds
      • OrcheChilds.build_objects()
      • OrcheChilds.dumped
      • OrcheChilds.groups
      • OrcheChilds.persons
      • OrcheChilds.subnets
      • OrcheChilds.systems
      • OrcheChilds.validate()
    • OrcheGroup
      • OrcheGroup.ansible
      • OrcheGroup.dumped
      • OrcheGroup.kind
      • OrcheGroup.params
      • OrcheGroup.realm
      • OrcheGroup.validate()
    • OrchePerson
      • OrchePerson.display
      • OrchePerson.domain
      • OrchePerson.dumped
      • OrchePerson.fqdn
      • OrchePerson.kind
      • OrchePerson.params
      • OrchePerson.realm
      • OrchePerson.validate()
    • OrcheSubnet
      • OrcheSubnet.kind
      • OrcheSubnet.params
      • OrcheSubnet.validate()
    • OrcheSystem
      • OrcheSystem.ansible
      • OrcheSystem.domain
      • OrcheSystem.dumped
      • OrcheSystem.fqdn
      • OrcheSystem.kind
      • OrcheSystem.params
      • OrcheSystem.realm
      • OrcheSystem.validate()
• orchestro.orche.params package
  • Submodules
  • orchestro.orche.params.child module
    • OrcheChildParams
      • OrcheChildParams.display
      • OrcheChildParams.enable
      • OrcheChildParams.inherits
      • OrcheChildParams.memberof
  • orchestro.orche.params.common module
    • OrcheParamsModel
  • orchestro.orche.params.group module
    • OrcheGroupAnsibleParams
    • OrcheGroupParams
      • OrcheGroupParams.ansible
      • OrcheGroupParams.display
      • OrcheGroupParams.enable
      • OrcheGroupParams.inherits
      • OrcheGroupParams.memberof
      • OrcheGroupParams.realm
  • orchestro.orche.params.orche module
    • OrcheParams
      • OrcheParams.database
      • OrcheParams.dryrun
      • OrcheParams.enconfig
      • OrcheParams.encrypts
      • OrcheParams.enlogger
      • OrcheParams.groups
      • OrcheParams.persons
      • OrcheParams.subnets
      • OrcheParams.systems
  • orchestro.orche.params.person module
    • OrchePersonParams
      • OrchePersonParams.display
      • OrchePersonParams.domain
      • OrchePersonParams.enable
      • OrchePersonParams.first
      • OrchePersonParams.inherits
      • OrchePersonParams.last
      • OrchePersonParams.memberof
      • OrchePersonParams.realm
  • orchestro.orche.params.subnet module
    • OrcheSubnetParams
      • OrcheSubnetParams.display
      • OrcheSubnetParams.enable
      • OrcheSubnetParams.inherits
      • OrcheSubnetParams.memberof
      • OrcheSubnetParams.subnet
  • orchestro.orche.params.system module
    • OrcheSystemAnsibleParams
    • OrcheSystemParams
      • OrcheSystemParams.ansible
      • OrcheSystemParams.display
      • OrcheSystemParams.domain
      • OrcheSystemParams.enable
      • OrcheSystemParams.inherits
      • OrcheSystemParams.memberof
      • OrcheSystemParams.realm
  • Module contents
    • OrcheChildParams
      • OrcheChildParams.display
      • OrcheChildParams.enable
      • OrcheChildParams.inherits
      • OrcheChildParams.memberof
    • OrcheGroupParams
      • OrcheGroupParams.ansible
      • OrcheGroupParams.display
      • OrcheGroupParams.enable
      • OrcheGroupParams.inherits
      • OrcheGroupParams.memberof
      • OrcheGroupParams.realm
    • OrcheParams
      • OrcheParams.database
      • OrcheParams.dryrun
      • OrcheParams.enconfig
      • OrcheParams.encrypts
      • OrcheParams.enlogger
      • OrcheParams.groups
      • OrcheParams.persons
      • OrcheParams.subnets
      • OrcheParams.systems
    • OrcheParamsModel
    • OrchePersonParams
      • OrchePersonParams.display
      • OrchePersonParams.domain
      • OrchePersonParams.enable
      • OrchePersonParams.first
      • OrchePersonParams.inherits
      • OrchePersonParams.last
      • OrchePersonParams.memberof
      • OrchePersonParams.realm
    • OrcheSubnetParams
      • OrcheSubnetParams.display
      • OrcheSubnetParams.enable
      • OrcheSubnetParams.inherits
      • OrcheSubnetParams.memberof
      • OrcheSubnetParams.subnet
    • OrcheSystemParams
      • OrcheSystemParams.ansible
      • OrcheSystemParams.display
      • OrcheSystemParams.domain
      • OrcheSystemParams.enable
      • OrcheSystemParams.inherits
      • OrcheSystemParams.memberof
      • OrcheSystemParams.realm
• orchestro.orche.test package
  • Submodules
  • orchestro.orche.test.test_config module
    • test_OrcheConfig()
  • orchestro.orche.test.test_models module
    • test_OrcheModels_cover()
  • orchestro.orche.test.test_orche module
    • test_Orche()
    • test_Orche_cover()
  • Module contents

Submodules

orchestro.orche.common 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.

orchestro.orche.config 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.config.OrcheConfig(sargs: dict[str, Any] | None = None, files: str | Path | list[str | Path] | tuple[str | Path] | set[str] | None = None, paths: str | Path | list[str | Path] | tuple[str | Path] | set[str] | None = None, cargs: dict[str, Any] | None = None)

Bases: Config

Contain the configurations from the arguments and files.

Parameters:

• sargs – Additional arguments on the command line.

• files – Complete or relative path to config files.

• paths – Complete or relative path to config paths.

• cargs – Configuration arguments in dictionary form, which will override contents from the config files.

merge_params() → None

Update the Pydantic model containing the configuration.

property params: OrcheParams

Return the Pydantic model containing the configuration.

Warning

This method completely overrides the parent but is based on that code, would be unfortunate if upstream changes meant this breaks or breaks something else.

Returns:

Pydantic model containing the configuration.

orchestro.orche.config.inheritance(dumped: dict[str, Any]) → None

Perform the inheritance after resolving the inheritance.

Parameters:

dumped – Source contents which will be processed.

orchestro.orche.models module

Functions and routines associated with Enasis Network Orche Automate.

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

class orchestro.orche.models.OrcheModels

Bases: object

Return the class object that was imported within method.

classmethod child() → Type[OrcheChildParams]

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

classmethod group() → Type[OrcheGroupParams]

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

classmethod orche() → Type[OrcheParams]

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

classmethod person() → Type[OrchePersonParams]

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

classmethod subnet() → Type[OrcheSubnetParams]

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

classmethod system() → Type[OrcheSystemParams]

Return the class object that was imported within method.

Returns:

Class object that was imported within method.

orchestro.orche.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.orche.Orche(config: OrcheConfig)

Bases: object

Interact with chat networks and integrate using plugins.

Parameters:

config – Primary class instance for configuration.

property childs: OrcheChilds

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property config: OrcheConfig

Return the Config instance containing the configuration.

Returns:

Config instance containing the configuration.

property dryrun: bool

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 logger: OrcheLogger

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property params: OrcheParams

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

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.Orche(config: OrcheConfig)

Bases: object

Interact with chat networks and integrate using plugins.

Parameters:

config – Primary class instance for configuration.

property childs: OrcheChilds

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property config: OrcheConfig

Return the Config instance containing the configuration.

Returns:

Config instance containing the configuration.

property dryrun: bool

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 logger: OrcheLogger

Return the value for the attribute from class instance.

Returns:

Value for the attribute from class instance.

property params: OrcheParams

Return the Pydantic model containing the configuration.

Returns:

Pydantic model containing the configuration.

class orchestro.orche.OrcheConfig(sargs: dict[str, Any] | None = None, files: str | Path | list[str | Path] | tuple[str | Path] | set[str] | None = None, paths: str | Path | list[str | Path] | tuple[str | Path] | set[str] | None = None, cargs: dict[str, Any] | None = None)

Bases: Config

Contain the configurations from the arguments and files.

Parameters:

• sargs – Additional arguments on the command line.

• files – Complete or relative path to config files.

• paths – Complete or relative path to config paths.

• cargs – Configuration arguments in dictionary form, which will override contents from the config files.

merge_params() → None

Update the Pydantic model containing the configuration.

property params: OrcheParams

Return the Pydantic model containing the configuration.

Warning

This method completely overrides the parent but is based on that code, would be unfortunate if upstream changes meant this breaks or breaks something else.

Returns:

Pydantic model containing the configuration.