Enasis Network Orchestrations#

Configuration Container#

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)[source]

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[source]

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.

Parameters Container#

pydantic model orchestro.orche.params.OrcheParams[source]

Bases: Params

Process and validate the core configuration parameters.

Show JSON schema
{
   "title": "OrcheParams",
   "description": "Process and validate the core configuration parameters.",
   "type": "object",
   "properties": {
      "enconfig": {
         "anyOf": [
            {
               "$ref": "#/$defs/ConfigParams"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Parameters for Config instance"
      },
      "enlogger": {
         "anyOf": [
            {
               "$ref": "#/$defs/LoggerParams"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Parameters for Logger instance"
      },
      "encrypts": {
         "anyOf": [
            {
               "$ref": "#/$defs/CryptsParams"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Parameters for Crypts instance"
      },
      "database": {
         "default": "sqlite:///:memory:",
         "description": "Database connection string",
         "minLength": 1,
         "title": "Database",
         "type": "string"
      },
      "dryrun": {
         "default": false,
         "description": "Determine if changes applied",
         "title": "Dryrun",
         "type": "boolean"
      },
      "systems": {
         "anyOf": [
            {
               "additionalProperties": {
                  "$ref": "#/$defs/OrcheSystemParams"
               },
               "minProperties": 1,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Parameters for Orche systems",
         "title": "Systems"
      },
      "persons": {
         "anyOf": [
            {
               "additionalProperties": {
                  "$ref": "#/$defs/OrchePersonParams"
               },
               "minProperties": 1,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Parameters for Orche persons",
         "title": "Persons"
      },
      "subnets": {
         "anyOf": [
            {
               "additionalProperties": {
                  "$ref": "#/$defs/OrcheSubnetParams"
               },
               "minProperties": 1,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Parameters for Orche subnets",
         "title": "Subnets"
      },
      "groups": {
         "anyOf": [
            {
               "additionalProperties": {
                  "$ref": "#/$defs/OrcheGroupParams"
               },
               "minProperties": 1,
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Parameters for Orche groups",
         "title": "Groups"
      },
      "kvparsed": {
         "additionalProperties": true,
         "description": "Additional metadata for child which is parsed after childs are instantiated and before Ansible consumes inventory",
         "minProperties": 0,
         "title": "Kvparsed",
         "type": "object"
      },
      "kvopaque": {
         "additionalProperties": true,
         "description": "Additional metadata for child which is parsed after childs are instantiated and when Ansible consumes inventory",
         "minProperties": 0,
         "title": "Kvopaque",
         "type": "object"
      }
   },
   "$defs": {
      "ConfigParams": {
         "additionalProperties": false,
         "description": "Process and validate the core configuration parameters.",
         "properties": {
            "paths": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "minItems": 1,
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Location of configuration files",
               "title": "Paths"
            }
         },
         "title": "ConfigParams",
         "type": "object"
      },
      "CryptParams": {
         "additionalProperties": false,
         "description": "Process and validate the core configuration parameters.",
         "properties": {
            "phrase": {
               "description": "Passphrase for the operations",
               "minLength": 1,
               "title": "Phrase",
               "type": "string"
            }
         },
         "required": [
            "phrase"
         ],
         "title": "CryptParams",
         "type": "object"
      },
      "CryptsParams": {
         "additionalProperties": false,
         "description": "Process and validate the core configuration parameters.",
         "properties": {
            "phrases": {
               "additionalProperties": {
                  "$ref": "#/$defs/CryptParams"
               },
               "description": "Passphrases for the operations",
               "minProperties": 0,
               "title": "Phrases",
               "type": "object"
            }
         },
         "required": [
            "phrases"
         ],
         "title": "CryptsParams",
         "type": "object"
      },
      "LoggerParams": {
         "additionalProperties": false,
         "description": "Process and validate the core configuration parameters.",
         "properties": {
            "stdo_level": {
               "anyOf": [
                  {
                     "enum": [
                        "critical",
                        "debug",
                        "error",
                        "info",
                        "warning"
                     ],
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Minimum logging message level",
               "title": "Stdo Level"
            },
            "file_level": {
               "anyOf": [
                  {
                     "enum": [
                        "critical",
                        "debug",
                        "error",
                        "info",
                        "warning"
                     ],
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Minimum logging message level",
               "title": "File Level"
            },
            "file_path": {
               "anyOf": [
                  {
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Enable output to the log file",
               "title": "File Path"
            }
         },
         "title": "LoggerParams",
         "type": "object"
      },
      "OrcheGroupAnsibleParams": {
         "additionalProperties": true,
         "description": "Process and validate the Orche configuration parameters.",
         "properties": {},
         "title": "OrcheGroupAnsibleParams",
         "type": "object"
      },
      "OrcheGroupParams": {
         "additionalProperties": false,
         "description": "Process and validate the Orche configuration parameters.",
         "properties": {
            "enable": {
               "default": false,
               "description": "Determine whether child enabled",
               "title": "Enable",
               "type": "boolean"
            },
            "inherits": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "minItems": 1,
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Other configuration to inherit",
               "title": "Inherits"
            },
            "display": {
               "anyOf": [
                  {
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Friendly name value for child",
               "title": "Display"
            },
            "about": {
               "anyOf": [
                  {
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Additional optional information",
               "title": "About"
            },
            "memberof": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "minItems": 1,
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Groups child is a member of",
               "title": "Memberof"
            },
            "kvparsed": {
               "additionalProperties": true,
               "description": "Additional metadata for child which is parsed after childs are instantiated and before Ansible consumes inventory",
               "minProperties": 0,
               "title": "Kvparsed",
               "type": "object"
            },
            "kvopaque": {
               "additionalProperties": true,
               "description": "Additional metadata for child which is parsed after childs are instantiated and when Ansible consumes inventory",
               "minProperties": 0,
               "title": "Kvopaque",
               "type": "object"
            },
            "realm": {
               "default": "ansible",
               "description": "Logical realm for the object",
               "enum": [
                  "domain",
                  "local",
                  "site",
                  "zone",
                  "ansible",
                  "psuedo"
               ],
               "title": "Realm",
               "type": "string"
            },
            "ansible": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/OrcheGroupAnsibleParams"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Variables provided to Ansible"
            }
         },
         "title": "OrcheGroupParams",
         "type": "object"
      },
      "OrchePersonParams": {
         "additionalProperties": false,
         "description": "Process and validate the Orche configuration parameters.",
         "properties": {
            "enable": {
               "default": false,
               "description": "Determine whether child enabled",
               "title": "Enable",
               "type": "boolean"
            },
            "inherits": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "minItems": 1,
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Other configuration to inherit",
               "title": "Inherits"
            },
            "display": {
               "anyOf": [
                  {
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Friendly name value for child",
               "title": "Display"
            },
            "about": {
               "anyOf": [
                  {
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Additional optional information",
               "title": "About"
            },
            "memberof": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "minItems": 1,
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Groups child is a member of",
               "title": "Memberof"
            },
            "kvparsed": {
               "additionalProperties": true,
               "description": "Additional metadata for child which is parsed after childs are instantiated and before Ansible consumes inventory",
               "minProperties": 0,
               "title": "Kvparsed",
               "type": "object"
            },
            "kvopaque": {
               "additionalProperties": true,
               "description": "Additional metadata for child which is parsed after childs are instantiated and when Ansible consumes inventory",
               "minProperties": 0,
               "title": "Kvopaque",
               "type": "object"
            },
            "realm": {
               "default": "psuedo",
               "description": "Logical realm for the object",
               "enum": [
                  "domain",
                  "local",
                  "psuedo"
               ],
               "title": "Realm",
               "type": "string"
            },
            "domain": {
               "anyOf": [
                  {
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Domain to which child belongs",
               "title": "Domain"
            },
            "first": {
               "anyOf": [
                  {
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "First name for person account",
               "title": "First"
            },
            "last": {
               "anyOf": [
                  {
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Last name for person account",
               "title": "Last"
            }
         },
         "title": "OrchePersonParams",
         "type": "object"
      },
      "OrcheSubnetParams": {
         "additionalProperties": false,
         "description": "Process and validate the Orche configuration parameters.",
         "properties": {
            "enable": {
               "default": false,
               "description": "Determine whether child enabled",
               "title": "Enable",
               "type": "boolean"
            },
            "inherits": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "minItems": 1,
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Other configuration to inherit",
               "title": "Inherits"
            },
            "display": {
               "anyOf": [
                  {
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Friendly name value for child",
               "title": "Display"
            },
            "about": {
               "anyOf": [
                  {
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Additional optional information",
               "title": "About"
            },
            "memberof": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "minItems": 1,
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Groups child is a member of",
               "title": "Memberof"
            },
            "kvparsed": {
               "additionalProperties": true,
               "description": "Additional metadata for child which is parsed after childs are instantiated and before Ansible consumes inventory",
               "minProperties": 0,
               "title": "Kvparsed",
               "type": "object"
            },
            "kvopaque": {
               "additionalProperties": true,
               "description": "Additional metadata for child which is parsed after childs are instantiated and when Ansible consumes inventory",
               "minProperties": 0,
               "title": "Kvopaque",
               "type": "object"
            },
            "subnet": {
               "description": "IPv4 or IPv6 network subnet",
               "minLength": 1,
               "title": "Subnet",
               "type": "string"
            },
            "macpref": {
               "anyOf": [
                  {
                     "maxLength": 2,
                     "minLength": 2,
                     "pattern": "^[\\da-fA-F]+$",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional prefix for MAC address",
               "title": "Macpref"
            },
            "gateway": {
               "anyOf": [
                  {
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional gateway for the subnet",
               "title": "Gateway"
            },
            "resolve": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "minItems": 1,
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional resolvers for subnet",
               "title": "Resolve"
            },
            "ntpsync": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "minItems": 1,
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Optional NTP server for subnet",
               "title": "Ntpsync"
            }
         },
         "required": [
            "subnet"
         ],
         "title": "OrcheSubnetParams",
         "type": "object"
      },
      "OrcheSystemAnsibleParams": {
         "additionalProperties": true,
         "description": "Process and validate the Orche configuration parameters.",
         "properties": {},
         "title": "OrcheSystemAnsibleParams",
         "type": "object"
      },
      "OrcheSystemParams": {
         "additionalProperties": false,
         "description": "Process and validate the Orche configuration parameters.",
         "properties": {
            "enable": {
               "default": false,
               "description": "Determine whether child enabled",
               "title": "Enable",
               "type": "boolean"
            },
            "inherits": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "minItems": 1,
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Other configuration to inherit",
               "title": "Inherits"
            },
            "display": {
               "anyOf": [
                  {
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Friendly name value for child",
               "title": "Display"
            },
            "about": {
               "anyOf": [
                  {
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Additional optional information",
               "title": "About"
            },
            "memberof": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "minItems": 1,
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Groups child is a member of",
               "title": "Memberof"
            },
            "kvparsed": {
               "additionalProperties": true,
               "description": "Additional metadata for child which is parsed after childs are instantiated and before Ansible consumes inventory",
               "minProperties": 0,
               "title": "Kvparsed",
               "type": "object"
            },
            "kvopaque": {
               "additionalProperties": true,
               "description": "Additional metadata for child which is parsed after childs are instantiated and when Ansible consumes inventory",
               "minProperties": 0,
               "title": "Kvopaque",
               "type": "object"
            },
            "realm": {
               "default": "ansible",
               "description": "Logical realm for the object",
               "enum": [
                  "ansible",
                  "psuedo"
               ],
               "title": "Realm",
               "type": "string"
            },
            "domain": {
               "anyOf": [
                  {
                     "minLength": 1,
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Domain to which child belongs",
               "title": "Domain"
            },
            "ansible": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/OrcheSystemAnsibleParams"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "Variables provided to Ansible"
            }
         },
         "title": "OrcheSystemParams",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Config:

  • extra: str = forbid

Fields:
field database: Annotated[str, FieldInfo(annotation=NoneType, required=False, default='sqlite:///:memory:', description='Database connection string', metadata=[MinLen(min_length=1)])] = 'sqlite:///:memory:'

Database connection string

Constraints:

  • min_length = 1

field dryrun: Annotated[bool, FieldInfo(annotation=NoneType, required=False, default=False, description='Determine if changes applied')] = False

Determine if changes applied

field groups: Annotated[dict[str, OrcheGroupParams] | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Parameters for Orche groups', metadata=[MinLen(min_length=1)])] = None

Parameters for Orche groups

Constraints:

  • min_length = 1

field kvopaque: Annotated[dict[str, Any], FieldInfo(annotation=NoneType, required=False, default_factory=dict, description='Additional metadata for child which is parsed after childs are instantiated and when Ansible consumes inventory', metadata=[MinLen(min_length=0)])] [Optional]

Additional metadata for child which is parsed after childs are instantiated and when Ansible consumes inventory

Constraints:

  • min_length = 0

field kvparsed: Annotated[dict[str, Any], FieldInfo(annotation=NoneType, required=False, default_factory=dict, description='Additional metadata for child which is parsed after childs are instantiated and before Ansible consumes inventory', metadata=[MinLen(min_length=0)])] [Optional]

Additional metadata for child which is parsed after childs are instantiated and before Ansible consumes inventory

Constraints:

  • min_length = 0

field persons: Annotated[dict[str, OrchePersonParams] | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Parameters for Orche persons', metadata=[MinLen(min_length=1)])] = None

Parameters for Orche persons

Constraints:

  • min_length = 1

field subnets: Annotated[dict[str, OrcheSubnetParams] | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Parameters for Orche subnets', metadata=[MinLen(min_length=1)])] = None

Parameters for Orche subnets

Constraints:

  • min_length = 1

field systems: Annotated[dict[str, OrcheSystemParams] | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Parameters for Orche systems', metadata=[MinLen(min_length=1)])] = None

Parameters for Orche systems

Constraints:

  • min_length = 1

Orche Children#

pydantic model orchestro.orche.params.OrcheSystemParams[source]

Bases: OrcheChildParams

Process and validate the Orche configuration parameters.

Show JSON schema
{
   "title": "OrcheSystemParams",
   "description": "Process and validate the Orche configuration parameters.",
   "type": "object",
   "properties": {
      "enable": {
         "default": false,
         "description": "Determine whether child enabled",
         "title": "Enable",
         "type": "boolean"
      },
      "inherits": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "minItems": 1,
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Other configuration to inherit",
         "title": "Inherits"
      },
      "display": {
         "anyOf": [
            {
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Friendly name value for child",
         "title": "Display"
      },
      "about": {
         "anyOf": [
            {
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Additional optional information",
         "title": "About"
      },
      "memberof": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "minItems": 1,
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Groups child is a member of",
         "title": "Memberof"
      },
      "kvparsed": {
         "additionalProperties": true,
         "description": "Additional metadata for child which is parsed after childs are instantiated and before Ansible consumes inventory",
         "minProperties": 0,
         "title": "Kvparsed",
         "type": "object"
      },
      "kvopaque": {
         "additionalProperties": true,
         "description": "Additional metadata for child which is parsed after childs are instantiated and when Ansible consumes inventory",
         "minProperties": 0,
         "title": "Kvopaque",
         "type": "object"
      },
      "realm": {
         "default": "ansible",
         "description": "Logical realm for the object",
         "enum": [
            "ansible",
            "psuedo"
         ],
         "title": "Realm",
         "type": "string"
      },
      "domain": {
         "anyOf": [
            {
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Domain to which child belongs",
         "title": "Domain"
      },
      "ansible": {
         "anyOf": [
            {
               "$ref": "#/$defs/OrcheSystemAnsibleParams"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Variables provided to Ansible"
      }
   },
   "$defs": {
      "OrcheSystemAnsibleParams": {
         "additionalProperties": true,
         "description": "Process and validate the Orche configuration parameters.",
         "properties": {},
         "title": "OrcheSystemAnsibleParams",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Config:

  • extra: str = forbid

Fields:
field ansible: Annotated[OrcheSystemAnsibleParams | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Variables provided to Ansible')] = None

Variables provided to Ansible

field domain: Annotated[str | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Domain to which child belongs', metadata=[MinLen(min_length=1)])] = None

Domain to which child belongs

Constraints:

  • min_length = 1

field realm: Annotated[Literal['ansible', 'psuedo'], FieldInfo(annotation=NoneType, required=False, default='ansible', description='Logical realm for the object')] = 'ansible'

Logical realm for the object

pydantic model orchestro.orche.params.OrchePersonParams[source]

Bases: OrcheChildParams

Process and validate the Orche configuration parameters.

Show JSON schema
{
   "title": "OrchePersonParams",
   "description": "Process and validate the Orche configuration parameters.",
   "type": "object",
   "properties": {
      "enable": {
         "default": false,
         "description": "Determine whether child enabled",
         "title": "Enable",
         "type": "boolean"
      },
      "inherits": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "minItems": 1,
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Other configuration to inherit",
         "title": "Inherits"
      },
      "display": {
         "anyOf": [
            {
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Friendly name value for child",
         "title": "Display"
      },
      "about": {
         "anyOf": [
            {
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Additional optional information",
         "title": "About"
      },
      "memberof": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "minItems": 1,
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Groups child is a member of",
         "title": "Memberof"
      },
      "kvparsed": {
         "additionalProperties": true,
         "description": "Additional metadata for child which is parsed after childs are instantiated and before Ansible consumes inventory",
         "minProperties": 0,
         "title": "Kvparsed",
         "type": "object"
      },
      "kvopaque": {
         "additionalProperties": true,
         "description": "Additional metadata for child which is parsed after childs are instantiated and when Ansible consumes inventory",
         "minProperties": 0,
         "title": "Kvopaque",
         "type": "object"
      },
      "realm": {
         "default": "psuedo",
         "description": "Logical realm for the object",
         "enum": [
            "domain",
            "local",
            "psuedo"
         ],
         "title": "Realm",
         "type": "string"
      },
      "domain": {
         "anyOf": [
            {
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Domain to which child belongs",
         "title": "Domain"
      },
      "first": {
         "anyOf": [
            {
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "First name for person account",
         "title": "First"
      },
      "last": {
         "anyOf": [
            {
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Last name for person account",
         "title": "Last"
      }
   },
   "additionalProperties": false
}

Config:

  • extra: str = forbid

Fields:
field domain: Annotated[str | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Domain to which child belongs', metadata=[MinLen(min_length=1)])] = None

Domain to which child belongs

Constraints:

  • min_length = 1

field first: Annotated[str | None, FieldInfo(annotation=NoneType, required=False, default=None, description='First name for person account', metadata=[MinLen(min_length=1)])] = None

First name for person account

Constraints:

  • min_length = 1

field last: Annotated[str | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Last name for person account', metadata=[MinLen(min_length=1)])] = None

Last name for person account

Constraints:

  • min_length = 1

field realm: Annotated[Literal['domain', 'local', 'psuedo'], FieldInfo(annotation=NoneType, required=False, default='psuedo', description='Logical realm for the object')] = 'psuedo'

Logical realm for the object

pydantic model orchestro.orche.params.OrcheSubnetParams[source]

Bases: OrcheChildParams

Process and validate the Orche configuration parameters.

Show JSON schema
{
   "title": "OrcheSubnetParams",
   "description": "Process and validate the Orche configuration parameters.",
   "type": "object",
   "properties": {
      "enable": {
         "default": false,
         "description": "Determine whether child enabled",
         "title": "Enable",
         "type": "boolean"
      },
      "inherits": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "minItems": 1,
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Other configuration to inherit",
         "title": "Inherits"
      },
      "display": {
         "anyOf": [
            {
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Friendly name value for child",
         "title": "Display"
      },
      "about": {
         "anyOf": [
            {
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Additional optional information",
         "title": "About"
      },
      "memberof": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "minItems": 1,
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Groups child is a member of",
         "title": "Memberof"
      },
      "kvparsed": {
         "additionalProperties": true,
         "description": "Additional metadata for child which is parsed after childs are instantiated and before Ansible consumes inventory",
         "minProperties": 0,
         "title": "Kvparsed",
         "type": "object"
      },
      "kvopaque": {
         "additionalProperties": true,
         "description": "Additional metadata for child which is parsed after childs are instantiated and when Ansible consumes inventory",
         "minProperties": 0,
         "title": "Kvopaque",
         "type": "object"
      },
      "subnet": {
         "description": "IPv4 or IPv6 network subnet",
         "minLength": 1,
         "title": "Subnet",
         "type": "string"
      },
      "macpref": {
         "anyOf": [
            {
               "maxLength": 2,
               "minLength": 2,
               "pattern": "^[\\da-fA-F]+$",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Optional prefix for MAC address",
         "title": "Macpref"
      },
      "gateway": {
         "anyOf": [
            {
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Optional gateway for the subnet",
         "title": "Gateway"
      },
      "resolve": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "minItems": 1,
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Optional resolvers for subnet",
         "title": "Resolve"
      },
      "ntpsync": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "minItems": 1,
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Optional NTP server for subnet",
         "title": "Ntpsync"
      }
   },
   "additionalProperties": false,
   "required": [
      "subnet"
   ]
}

Config:

  • extra: str = forbid

Fields:
field gateway: Annotated[str | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Optional gateway for the subnet', metadata=[MinLen(min_length=1)])] = None

Optional gateway for the subnet

Constraints:

  • min_length = 1

field macpref: Annotated[str | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Optional prefix for MAC address', metadata=[MinLen(min_length=2), MaxLen(max_length=2), _PydanticGeneralMetadata(pattern='^[\\da-fA-F]+$')])] = None

Optional prefix for MAC address

Constraints:

  • min_length = 2

  • max_length = 2

  • pattern = ^[da-fA-F]+$

field ntpsync: Annotated[list[str] | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Optional NTP server for subnet', metadata=[MinLen(min_length=1)])] = None

Optional NTP server for subnet

Constraints:

  • min_length = 1

field resolve: Annotated[list[str] | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Optional resolvers for subnet', metadata=[MinLen(min_length=1)])] = None

Optional resolvers for subnet

Constraints:

  • min_length = 1

field subnet: Annotated[str, FieldInfo(annotation=NoneType, required=True, description='IPv4 or IPv6 network subnet', metadata=[MinLen(min_length=1)])] [Required]

IPv4 or IPv6 network subnet

Constraints:

  • min_length = 1

pydantic model orchestro.orche.params.OrcheGroupParams[source]

Bases: OrcheChildParams

Process and validate the Orche configuration parameters.

Show JSON schema
{
   "title": "OrcheGroupParams",
   "description": "Process and validate the Orche configuration parameters.",
   "type": "object",
   "properties": {
      "enable": {
         "default": false,
         "description": "Determine whether child enabled",
         "title": "Enable",
         "type": "boolean"
      },
      "inherits": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "minItems": 1,
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Other configuration to inherit",
         "title": "Inherits"
      },
      "display": {
         "anyOf": [
            {
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Friendly name value for child",
         "title": "Display"
      },
      "about": {
         "anyOf": [
            {
               "minLength": 1,
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Additional optional information",
         "title": "About"
      },
      "memberof": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "minItems": 1,
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Groups child is a member of",
         "title": "Memberof"
      },
      "kvparsed": {
         "additionalProperties": true,
         "description": "Additional metadata for child which is parsed after childs are instantiated and before Ansible consumes inventory",
         "minProperties": 0,
         "title": "Kvparsed",
         "type": "object"
      },
      "kvopaque": {
         "additionalProperties": true,
         "description": "Additional metadata for child which is parsed after childs are instantiated and when Ansible consumes inventory",
         "minProperties": 0,
         "title": "Kvopaque",
         "type": "object"
      },
      "realm": {
         "default": "ansible",
         "description": "Logical realm for the object",
         "enum": [
            "domain",
            "local",
            "site",
            "zone",
            "ansible",
            "psuedo"
         ],
         "title": "Realm",
         "type": "string"
      },
      "ansible": {
         "anyOf": [
            {
               "$ref": "#/$defs/OrcheGroupAnsibleParams"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Variables provided to Ansible"
      }
   },
   "$defs": {
      "OrcheGroupAnsibleParams": {
         "additionalProperties": true,
         "description": "Process and validate the Orche configuration parameters.",
         "properties": {},
         "title": "OrcheGroupAnsibleParams",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Config:

  • extra: str = forbid

Fields:
field ansible: Annotated[OrcheGroupAnsibleParams | None, FieldInfo(annotation=NoneType, required=False, default=None, description='Variables provided to Ansible')] = None

Variables provided to Ansible

field realm: Annotated[Literal['domain', 'local', 'site', 'zone', 'ansible', 'psuedo'], FieldInfo(annotation=NoneType, required=False, default='ansible', description='Logical realm for the object')] = 'ansible'

Logical realm for the object