Inmanta Reference

Welcome to the Inmanta reference guide!

Here we explain all the features and options of Inmanta. If you’re just looking to get started with Inmanta, please check out the Quickstart guide.

• Command Reference
  • inmanta
    • Named Arguments
    • Sub-commands
      • server
        • Named Arguments
      • scheduler
        • Named Arguments
      • compile
        • Named Arguments
      • list-commands
      • help
        • Positional Arguments
      • modules (module)
        • Named Arguments
        • subcommand
        • Sub-commands
          • add
            • Positional Arguments
            • Named Arguments
          • list
            • Named Arguments
          • install
            • Positional Arguments
            • Named Arguments
          • status
            • Named Arguments
          • push
            • Named Arguments
          • verify
            • Named Arguments
          • create
            • Positional Arguments
            • Named Arguments
          • freeze
            • Named Arguments
          • build
            • Positional Arguments
            • Named Arguments
          • v1tov2
            • Named Arguments
          • release
            • Named Arguments
          • download
            • Positional Arguments
            • Named Arguments
      • project
        • Named Arguments
        • subcommand
        • Sub-commands
          • freeze
            • Named Arguments
          • init
            • Named Arguments
          • install
            • Named Arguments
          • update
            • Named Arguments
          • download
            • Named Arguments
      • export
        • Named Arguments
      • validate-logging-config
        • Named Arguments
        • subcommand
        • Sub-commands
          • server
            • Named Arguments
          • scheduler
            • Named Arguments
          • compiler
            • Named Arguments
      • output-default-logging-config
        • Positional Arguments
        • Named Arguments
      • policy-engine
        • Named Arguments
        • subcommand
        • Sub-commands
          • print-endpoint-data
            • Named Arguments
  • inmanta-cli
    • inmanta-cli
      • action-log
        • list
        • show-messages
      • agent
        • list
        • pause
        • unpause
      • environment
        • create
        • delete
        • list
        • modify
        • recompile
        • save
        • setting
          • delete
          • get
          • list
          • set
        • show
      • lsm
        • resources
          • list
        • service-entities
          • list
        • service-instances
          • list
      • monitor
      • param
        • get
        • list
        • set
      • project
        • create
        • delete
        • list
        • modify
        • show
      • token
        • bootstrap
        • create
      • version
        • list
        • release
        • report
• Configuration Reference
  • agent
  • agent_rest_transport
  • client_rest_transport
  • cmdline_rest_transport
  • compiler
  • compiler_rest_transport
  • config
  • database
  • influxdb
  • license
  • logging
  • lsm.callback
  • policy_engine
  • scheduler
  • server
  • web-ui
• Environment Settings Reference
• Compiler Configuration Reference
  • project.yml
    • ProjectMetadata
    • ProjectPipConfig
    • Configure pip index
      • pip.use-system-config
      • Example scenario
    • Migrate to project-wide pip config
      • Breaking changes:
      • Changes relative to inmanta-2023.4 (OSS):
    • Environment settings
  • Module metadata files
    • module.yml
      • ModuleMetadata
    • setup.cfg
• Programmatic API reference
  • Constants
    • LogLevel
      • LogLevel.CRITICAL
      • LogLevel.DEBUG
      • LogLevel.ERROR
      • LogLevel.INFO
      • LogLevel.TRACE
      • LogLevel.WARNING
      • LogLevel.to_int
    • ResourceAction
      • ResourceAction.deploy
      • ResourceAction.dryrun
      • ResourceAction.getfact
      • ResourceAction.other
      • ResourceAction.pull
      • ResourceAction.push
      • ResourceAction.store
    • inmanta_lsm.const.LSM_ENV_VARS
  • Compiler exceptions
    • CompilerException
    • ParserException
    • RuntimeException
    • ExternalException
    • ExplicitPluginException
  • Plugins
    • Context
      • Context.get_client()
      • Context.get_compiler()
      • Context.get_data_dir()
      • Context.get_environment_id()
      • Context.get_queue_scheduler()
      • Context.get_resolver()
      • Context.get_sync_client()
      • Context.get_type()
      • Context.run_sync()
    • plugin()
    • PluginException
    • PluginMeta
      • PluginMeta.add_function()
      • PluginMeta.clear()
      • PluginMeta.get_functions()
    • UnsetException
    • allow_reference_values()
  • Resources
    • resource()
    • Resource
      • Resource.clone()
    • PurgeableResource
    • ManagedResource
    • IgnoreResourceException
    • Id
      • Id.parse_id()
      • Id.resource_str()
    • Unknown
  • Handlers
    • cache()
    • provider()
    • SkipResource
    • SkipResourceForDependencies
    • ResourcePurged
    • HandlerContext
      • HandlerContext.add_change()
      • HandlerContext.add_changes()
      • HandlerContext.fields_updated()
      • HandlerContext.is_dry_run()
      • HandlerContext.set_fact()
      • HandlerContext.set_resource_state()
      • HandlerContext.set_status()
      • HandlerContext.update_changes()
    • ResourceHandler
      • ResourceHandler._abc_impl
      • ResourceHandler._diff()
      • ResourceHandler.check_facts()
      • ResourceHandler.check_resource()
      • ResourceHandler.do_changes()
      • ResourceHandler.execute()
      • ResourceHandler.list_changes()
    • CRUDHandler
      • CRUDHandler.calculate_diff()
      • CRUDHandler.can_reload()
      • CRUDHandler.check_facts()
      • CRUDHandler.check_resource()
      • CRUDHandler.close()
      • CRUDHandler.create_resource()
      • CRUDHandler.delete_resource()
      • CRUDHandler.deploy()
      • CRUDHandler.do_changes()
      • CRUDHandler.do_reload()
      • CRUDHandler.execute()
      • CRUDHandler.facts()
      • CRUDHandler.get_client()
      • CRUDHandler.get_file()
      • CRUDHandler.list_changes()
      • CRUDHandler.post()
      • CRUDHandler.pre()
      • CRUDHandler.read_resource()
      • CRUDHandler.run_sync()
      • CRUDHandler.set_cache()
      • CRUDHandler.stat_file()
      • CRUDHandler.update_resource()
      • CRUDHandler.upload_file()
  • References
    • Reference
    • reference()
  • Export
    • dependency_manager()
  • Attributes
    • Attribute
      • Attribute.get_type()
      • Attribute.type
      • Attribute.validate()
    • RelationAttribute
  • Modules
    • InstallMode
      • InstallMode.master
      • InstallMode.prerelease
      • InstallMode.release
    • INSTALL_OPTS
    • InvalidModuleException
    • InvalidMetadata
    • ModuleLike
      • ModuleLike.from_path()
      • ModuleLike.metadata
    • Module
      • Module.from_path()
      • Module.get_plugin_files()
      • Module.unload()
    • ModuleName
    • ModuleV1
      • ModuleV1.from_path()
    • ModuleV2
      • ModuleV2.from_path()
      • ModuleV2.is_editable()
    • ModuleSource
      • ModuleSource.get_installed_module()
    • ModuleV2Source
    • Path
    • PluginModuleFinder
      • PluginModuleFinder.reset()
    • unload_inmanta_plugins()
  • Project
    • Project
      • Project.get()
      • Project.install_modules()
      • Project.load()
      • Project.set()
    • ProjectNotFoundException
  • Python Environment
    • mock_process_env()
    • VirtualEnv
      • VirtualEnv.init_env()
      • VirtualEnv.use_virtual_env()
  • Variables
    • Reference
      • Reference.name
  • Typing
    • Type
      • Type.get_base_type()
      • Type.type_string()
      • Type.validate()
      • Type.with_base_type()
    • NullableType
    • Primitive
      • Primitive.cast()
    • Number
    • Integer
    • Bool
    • String
    • Union
    • Literal
    • List
    • TypedList
    • LiteralList
    • Dict
    • TypedDict
    • LiteralDict
    • ConstraintType
    • TYPES
  • Protocol
    • Result
      • Result.result
  • Data
    • inmanta.data.TBaseDocument
    • BaseDocument
      • BaseDocument.get_by_id()
      • BaseDocument.get_list()
    • Compile
      • Compile.get_substitute_by_id()
      • Compile.to_dto()
    • ConfigurationModel
      • ConfigurationModel.get_versions()
    • Environment
    • Report
    • Resource
      • Resource.get_resources_for_version()
    • ResourceAction
      • ResourceAction.get_logs_for_version()
    • BaseModel
    • ResourceIdStr
    • ResourceVersionIdStr
    • PGRestore
    • clear_database()
  • Domain conversion
    • DynamicProxy
      • DynamicProxy.return_value()
      • DynamicProxy.unwrap()
  • Rest API
    • clear_environment()
    • create_environment()
    • create_project()
    • create_token()
    • delete_environment()
    • delete_param()
    • delete_project()
    • delete_setting()
    • delete_version()
    • deploy()
    • diff()
    • do_dryrun()
    • dryrun_list()
    • dryrun_report()
    • dryrun_request()
    • dryrun_update()
    • get_agent_process()
    • get_compile_queue()
    • get_file()
    • get_param()
    • get_parameter()
    • get_project()
    • get_report()
    • get_reports()
    • get_resource()
    • get_server_status()
    • get_setting()
    • get_state()
    • get_status()
    • get_version()
    • heartbeat()
    • heartbeat_reply()
    • ignore_env()
    • is_compiling()
    • list_agent_processes()
    • list_agents()
    • list_environments()
    • list_params()
    • list_projects()
    • list_settings()
    • list_versions()
    • modify_environment()
    • modify_project()
    • notify_change()
    • notify_change_get()
    • put_version()
    • release_version()
    • set_param()
    • set_parameters()
    • set_setting()
    • set_state()
    • stat_file()
    • stat_files()
    • trigger()
    • trigger_read_version()
    • upload_file()
    • add_user()
    • agent_action()
    • all_agents_action()
    • assign_role()
    • compile_details()
    • create_role()
    • delete_role()
    • delete_user()
    • discovered_resource_create()
    • discovered_resource_create_batch()
    • discovered_resources_get()
    • discovered_resources_get_batch()
    • dryrun_trigger()
    • environment_clear()
    • environment_create()
    • environment_create_token()
    • environment_delete()
    • environment_get()
    • environment_list()
    • environment_modify()
    • environment_setting_delete()
    • environment_setting_get()
    • environment_settings_list()
    • environment_settings_set()
    • get_agent_process_details()
    • get_agents()
    • get_all_facts()
    • get_api_docs()
    • get_compile_data()
    • get_compile_reports()
    • get_current_user()
    • get_db_status()
    • get_diff_of_versions()
    • get_dryrun_diff()
    • get_environment_metrics()
    • get_fact()
    • get_facts()
    • get_notification()
    • get_parameters()
    • get_pip_config()
    • get_resource_actions()
    • get_resource_events()
    • get_resources_in_version()
    • get_scheduler_status()
    • graphql()
    • graphql_schema()
    • halt_environment()
    • health()
    • list_desired_state_versions()
    • list_dryruns()
    • list_notifications()
    • list_roles()
    • list_roles_for_user()
    • list_users()
    • login()
    • notify_timer_update()
    • project_create()
    • project_delete()
    • project_get()
    • project_list()
    • project_modify()
    • promote_desired_state_version()
    • protected_environment_settings_set_batch()
    • put_partial()
    • remove_executor_venvs()
    • reserve_version()
    • resource_details()
    • resource_did_dependency_change()
    • resource_history()
    • resource_list()
    • resource_logs()
    • resume_environment()
    • set_fact()
    • set_is_admin()
    • set_parameter()
    • set_password()
    • trigger_get_status()
    • unassign_role()
    • update_notification()
    • versioned_resource_details()
  • Server
    • ApplicationContext
    • InmantaBootloader
• Inmanta Compile Data Reference
  • CompileData
    • CompileData.errors
    • CompileData.model_config
  • Error
    • Error.category
    • Error.location
    • Error.message
    • Error.model_config
    • Error.type
  • ErrorCategory
    • ErrorCategory.parser
    • ErrorCategory.plugin
    • ErrorCategory.runtime
  • Location
    • Location.model_config
    • Location.range
    • Location.uri
  • Range
    • Range.end
    • Range.model_config
    • Range.start
  • Position
    • Position.character
    • Position.line
    • Position.model_config
• Inmanta Expert Features
  • Compiler expert features
    • Allow handler code update during a partial compile
  • Lsm extension expert features
    • Forcefully set a service in a state
    • Forcefully destroy a service
    • Forcefully update attributes of a service
• Inmanta modules
  • Modules
    • Adapter
    • Base modules
    • Product modules
    • Utilities
  • Module documentation overview
    • aci adapter
      • Features
      • Api configuration
      • Usage example
        • Module aci
          • Typedefs
          • Entities
          • Implementations
          • Plugins
            • aci.format_from_dict()
            • aci.format_from_entity()
          • Resources
            • aci.resources.StandaloneResource
            • aci.resources.RelativeResource
            • aci.resources.RelativeResource
            • aci.resources.RelativeResource
            • aci.resources.RelativeResource
            • aci.resources.RelativeResource
            • aci.resources.RelativeResource
            • aci.resources.RelativeResource
            • aci.resources.RelativeResource
            • aci.resources.RelativeResource
            • aci.resources.RelativeResource
            • aci.resources.RelativeResource
            • aci.resources.RelativeResource
            • aci.resources.RelativeResource
            • aci.resources.RelativeResource
            • aci.resources.RelativeResource
            • aci.resources.RelativeResource
            • aci.resources.RelativeResource
            • aci.resources.RelativeResource
            • aci.resources.RelativeResource
            • aci.resources.RelativeResource
            • aci.resources.RelativeResource
            • aci.resources.RelativeResource
          • Handlers
            • aci.resources.StandaloneProvider
            • aci.resources.RelativeProvider
        • Changelog
          • v0.2.0 - 2025-08-08
          • v0.1.3 - 2024-09-26
          • v0.1.2 - 2024-02-15
          • v0.1.1 - 2024-01-10
          • v0.1.0 - 2023-12-12
    • apt adapter
      • Features
      • Usage example
        • Module apt
          • Entities
          • Implementations
          • Resources
            • apt.Package
          • Handlers
            • apt.AptPackage
        • Changelog
          • v1.0.0 - 2024-09-17
    • athonet_core adapter
      • Changelog
        • v23.4.2.5 - 2025-07-09
        • v23.4.2.4 - 2025-04-03
        • v23.4.2.3 - 2025-02-07
        • v23.4.2.2 - 2024-11-28
        • v23.4.2.1 - 2024-11-18
        • v23.4.2.0 - 2024-11-06
        • v23.4.1.7 - 2024-09-16
        • v23.4.1.6 - 2024-07-16
        • v23.4.1.5 - 2024-06-25
        • v23.4.1.4 - 2024-06-03
        • v23.4.1.3 - 2024-04-23
        • v23.4.1.2 - 2024-04-16
        • v23.4.1.1 - 2024-04-08
        • v23.4.1 - 2024-03-27
        • v23.4.0 - 2024-03-11
        • v23.3.0 - 2024-02-15
        • v23.2.0.3 - 2024-01-16
        • v23.2.0.2 - 2024-01-03
        • v23.2.0.1 - 2023-11-27
        • v23.1.0.1 - 2023-09-26
        • v5.0.2.1 - 2023-08-03
        • v0.1.0 - ?
    • athonet_ims adapter
      • Changelog
        • v23.3.2.2 - 2025-10-15
        • v23.3.2.1 - 2025-07-09
        • v23.3.2 - 2025-04-03
        • v23.3.1.3 - 2024-11-06
        • v23.3.1.2 - 2024-09-16
        • v23.3.1.1 - 2024-06-03
        • v5.2.2.6 - 2024-05-31
        • v5.2.2.5 - 2024-04-23
        • v5.2.2.4 - 2024-04-08
        • v5.2.2.3 - 2024-03-27
        • v5.2.2.2 - 2024-03-08
        • v5.2.2.1 - 2024-01-16
      • Examples
    • athonet_mpn Module
      • Changelog
        • v0.10.6 - 2025-10-15
        • v0.10.5 - 2025-08-19
        • v0.10.4 - 2025-08-05
        • v0.10.3 - 2025-07-09
        • v0.10.2 - 2025-07-08
        • v0.10.1 - 2025-06-02
        • v0.10.0 - 2025-04-03
        • v0.9.31 - 2025-02-07
        • v0.9.30 - 2024-11-26
        • v0.9.29 - 2024-11-18
        • v0.9.28 - 2024-10-25
        • v0.9.27 - 2024-10-21
        • v0.9.26 - 2024-10-03
        • v0.9.25 - 2024-09-24
        • v0.9.24 - 2024-09-12
        • v0.9.23 - 2024-07-17
        • v0.9.22 - 2024-07-16
        • v0.9.21 - 2024-06-24
        • v0.9.20 - 2024-06-12
        • v0.9.19 - 2024-06-05
        • v0.9.18 - 2024-06-05
        • v0.9.17 - 2024-06-03
        • v0.9.16 - 2024-05-30
        • v0.9.15 - 2024-05-15
        • v0.9.14 - 2024-05-15
        • v0.9.13 - 2024-05-14
        • v0.9.12 - 2024-05-07
        • v0.9.11 - 2024-05-03
        • v0.9.10 - 2024-04-22
        • v0.9.9 - 2024-04-17
        • v0.9.8 - 2024-04-16
        • v0.9.7 - 2024-04-14
        • v0.9.6 - 2024-03-29
        • v0.9.5 - 2024-03-28
        • v0.9.4 - 2024-03-12
        • v0.9.3 - 2024-03-11
        • v0.9.2 - 2024-01-17
        • v0.9.1 - 2024-01-16
        • v0.9.0 - 2024-01-15
    • aws adapter
      • Usage example
        • Module aws
          • Typedefs
          • Entities
          • Implementations
          • Plugins
            • aws.elbid()
            • aws.get_api_id()
          • Resources
            • aws.ELB
            • aws.InternetGateway
            • aws.Route
            • aws.SecurityGroup
            • aws.Subnet
            • aws.VPC
            • aws.VirtualMachine
            • aws.Volume
            • aws.ElasticSearch
            • aws.RDS
          • Handlers
            • aws.ELBHandler
            • aws.VirtualMachineHandler
            • aws.VolumeHandler
            • aws.ElasticSearchHandler
            • aws.RDSHandler
            • aws.VPCHandler
            • aws.RouteHandler
            • aws.SubnetHandler
            • aws.InternetGatewayHandler
            • aws.SecurityGroupHandler
        • Changelog
          • v4.0.6 - 2024-10-04
          • v4.0.5 - 2024-10-03
          • v4.0.4 - 2024-07-12
          • v4.0.3 - 2024-07-05
          • v4.0.2 - 2024-04-09
          • v4.0.1 - 2024-03-29
          • v4.0.0 - 2023-12-07
          • v3.2.13 - 2023-10-12
          • v3.2.12 - 2023-06-30
          • v3.2.11 - 2023-05-08
          • v3.2.10 - 2023-04-04
          • v3.2.9 - 2023-04-04
          • v3.2.8 - 2023-02-07
          • v3.1.12
          • v3.1.11
          • v3.1.10
          • v3.1.7
          • v3.1.6
          • v3.1.4
          • v3.1.3
          • v3.0.10
          • v3.0.9
          • v3.0.8
          • v3.0.7
          • v3.0.6
          • v3.0.5
          • v3.0.4
          • v3.0.3
          • v3.0.2
          • v3.0.1
          • v3.0.0
    • aws_dc adapter
      • The states used by AWS:
      • The behaviour of the handler in certain states:
      • The collected facts for the HostedConnection:
      • HostedConnection attributes definition docs:
      • Maximum MTU for DirectConnect:
        • Module aws_dc
          • Typedefs
          • Entities
          • Implementations
          • Plugins
            • aws_dc.validate_aws_state_set()
          • Resources
            • aws_dc.HostedConnection
            • aws_dc.HostedConnectionState
          • Handlers
            • aws_dc.HostedConnectionHandler
            • aws_dc.HostedConnectionStateHandler
        • Changelog
          • v2.0.1 - 2024-09-05
          • v2.0.0 - 2024-06-19
          • v1.4.1 - 2023-11-27
          • V1.4.0 - 2022/07/26
          • V1.3.0 - 2022/07/11
          • V1.2.0 - 2020/09/14
          • V1.1.1 - 2020/05/11
          • V1.1.0 - 2020/03/13
          • V1.0.0 - 2020/02/27
          • v0.1.0
    • azure_expressroute adapter
      • Environment variables
      • Usage example
        • Module azure_expressroute
          • Typedefs
          • Entities
          • Implementations
          • Resources
            • azure_expressroute.CrossConnection
          • Handlers
            • azure_expressroute.CrossConnectionHandler
        • Changelog
          • v2.0.0 - 2024-10-09
          • v1.3.2 - 2024-09-05
          • v1.3.1 - 2024-01-23
          • v1.3.0 - 2023-12-14
          • v1.2.0 - 2022/10/17
          • v1.1.0 - 2022/07/14
          • v1.0.2 - 2021/05/20
          • v1.0.1 - 2021/05/18
          • v1.0.0 - 2021/05/11
    • checkpoint adapter
      • Environment Variables
      • Usage example
      • Design limitations
        • PolicyInstallV2
        • PolicyInstall
        • Lazy start and stop
          • Module checkpoint
            • Typedefs
            • Entities
            • Implementations
            • Plugins
              • checkpoint.gather_hosts_names()
              • checkpoint.gather_named_objects()
            • Resources
              • checkpoint.CommonService
              • checkpoint.Group
              • checkpoint.Host
              • checkpoint.ICMPService
              • checkpoint.Interface
              • checkpoint.Network
              • checkpoint.PolicyInstallV2
              • checkpoint.PolicyInstallV3
              • checkpoint.Route
              • checkpoint.Rule
              • checkpoint.RunScript
              • checkpoint.SharedGroup
              • checkpoint.SharedGroupSubResource
            • Handlers
              • checkpoint.RunScriptHandler
              • checkpoint.InterfaceHandler
              • checkpoint.RouteHandler
              • checkpoint.PolicyInstallV2Handler
              • checkpoint.PolicyInstallV3Handler
              • checkpoint.SharedGroupHandler
              • checkpoint.CheckpointObjectHandler
          • Changelog
            • v5.0.0 - 2025-07-10
            • v4.0.0 - 2025-04-23
            • v3.0.0 - 2024-11-07
            • v2.2.8 - 2024-09-26
            • v2.2.7 - 2024-09-25
            • v2.2.6 - 2024-07-24
            • v2.2.5 - 2024-05-23
            • v2.2.4 - 2024-02-22
            • v2.2.3 - 2024-01-23
            • v2.2.2 - 2023-11-27
            • v2.2.1 - 2023-08-29
            • v2.2.0 - 2023-08-25
            • v2.1.6 - 2023-08-10
            • v2.1.5 - 2023-07-05
            • v2.1.4 - 2023-06-06
            • v2.1.3 - 2023-05-25
            • v2.1.2 - 2023-05-09
            • v2.1.1 - 2023-05-02
            • v2.1.0 - 2023-04-24
            • v2.0.2 - 2023-04-07
            • v2.0.1 - 2023-02-02
            • v2.0.0
            • v2.1.7 - ?
            • v2.1.8 - ?
            • v1.7.0
            • v1.6.0
            • v1.5.4
            • v1.5.3
            • v1.5.2
            • v1.5.1
            • v1.5.0
            • v1.4.6
            • v1.4.5
            • v1.4.4
            • v1.4.3
            • v1.4.2
            • v1.4.1
            • v1.4.0
            • v1.3.3
            • v1.3.2
            • v1.3.1
            • v1.3.0
            • v1.2.0
            • v1.0.0
    • Ciena Saos Module
      • Operations
    • cisco_xe adapter
      • Features
      • Environment variables
      • Usage example
        • Module cisco_xe
          • Entities
          • Implementations
        • Changelog
          • v17.3.13 - 2025-10-07
          • v17.3.12 - 2025-08-08
          • v17.3.11 - 2025-02-11
          • v17.3.10 - 2024-11-28
          • v17.3.9 - 2024-09-26
          • v17.3.8 - 2024-07-17
          • v17.3.7 - 2023-11-27
          • v17.3.6 - 2023-09-04
          • v17.3.5 - 2023-03-20
    • cisco_xr adapter
      • Features
      • Environment variables
      • Usage example
        • Module cisco_xr
          • Typedefs
          • Entities
          • Implementations
          • Resources
            • cisco_xr.eth_cfm_state.EthCFMStateResource
          • Handlers
            • cisco_xr.eth_cfm_state.EthCFMStateHandler
        • Changelog
          • v7.9.4.5 - 2025-10-07
          • v7.9.4.4 - 2025-08-08
          • v7.9.4.3 - 2025-02-11
          • v7.9.4.2 - 2024-11-28
          • v7.9.4.1 - 2024-09-26
          • v7.9.4 - 2024-07-16
          • v7.9.3.1 - 2024-04-29
          • v7.9.3 - 2024-01-16
          • v7.9.2.3 - 2023-11-08
          • v7.9.2.2 - 2023-10-31
          • v7.9.2.1 - 2023-10-19
          • v7.2.5 - 2023-03-20
          • v7.2.4 - 2023-03-17
    • cloudflare adapter
      • Usage example
        • Module cloudflare
          • Typedefs
          • Entities
          • Implementations
          • Resources
            • cloudflare.accounts.access_app.AccessAppResource
            • cloudflare.accounts.access_app.AccessAppCertificateResource
            • cloudflare.accounts.access_app.AccessAppPolicyResource
            • cloudflare.accounts.access_group.AccessGroupResource
            • cloudflare.accounts.access_idp.AccessIdpResource
            • cloudflare.accounts.AccountResource
            • cloudflare.accounts.cfd_tunnel.CfdTunnelResource
            • cloudflare.zones.dns_record.DnsRecordResource
            • cloudflare.accounts.teamnet.TunnelRouteResource
            • cloudflare.accounts.teamnet.TunnelVirtualNetworkResource
            • cloudflare.zones.ZoneResource
            • cloudflare.accounts.access_app.ActualAccessAppResource
            • cloudflare.accounts.access_app.ActualAccessAppResource
            • cloudflare.accounts.access_app.ActualAccessAppResource
            • cloudflare.accounts.access_app.ActualAccessAppResource
            • cloudflare.accounts.access_app.ActualAccessAppResource
            • cloudflare.accounts.access_app.ActualAccessAppResource
            • cloudflare.accounts.access_app.ActualAccessAppResource
            • cloudflare.accounts.access_app.ActualAccessAppResource
            • cloudflare.zones.dns_record_discovery.DnsRecordDiscoveryResource
            • cloudflare.accounts.zone_discovery.ZoneDiscoveryResource
            • cloudflare.zones.dns_record.ActualDnsRecordResource
            • cloudflare.zones.dns_record.ActualDnsRecordResource
            • cloudflare.zones.dns_record.ActualDnsRecordResource
            • cloudflare.zones.dns_record.ActualDnsRecordResource
            • cloudflare.zones.dns_record.ActualDnsRecordResource
            • cloudflare.zones.dns_record.ActualDnsRecordResource
            • cloudflare.zones.dns_record.ActualDnsRecordResource
            • cloudflare.zones.dns_record.ActualDnsRecordResource
            • cloudflare.zones.dns_record.ActualDnsRecordResource
            • cloudflare.zones.dns_record.ActualDnsRecordResource
            • cloudflare.zones.dns_record.ActualDnsRecordResource
            • cloudflare.zones.dns_record.ActualDnsRecordResource
            • cloudflare.zones.dns_record.ActualDnsRecordResource
            • cloudflare.zones.dns_record.ActualDnsRecordResource
            • cloudflare.zones.dns_record.ActualDnsRecordResource
            • cloudflare.zones.dns_record.ActualDnsRecordResource
            • cloudflare.zones.dns_record.ActualDnsRecordResource
            • cloudflare.zones.dns_record.ActualDnsRecordResource
            • cloudflare.zones.dns_record.ActualDnsRecordResource
            • cloudflare.zones.dns_record.ActualDnsRecordResource
          • Handlers
            • cloudflare.accounts.AccountHandler
            • cloudflare.accounts.access_app.AccessAppHandler
            • cloudflare.accounts.access_app.AccessAppCertificateHandler
            • cloudflare.accounts.access_app.AccessAppPolicyHandler
            • cloudflare.accounts.access_group.AccessGroupHandler
            • cloudflare.accounts.access_idp.AccessIdpHandler
            • cloudflare.accounts.cfd_tunnel.CfdTunnelHandler
            • cloudflare.accounts.teamnet.TunnelRouteHandler
            • cloudflare.accounts.teamnet.TunnelVirtualNetworkHandler
            • cloudflare.zones.ZoneHandler
            • cloudflare.accounts.zone_discovery.ZoneDiscoveryHandler
            • cloudflare.zones.dns_record.DnsRecordHandler
            • cloudflare.zones.dns_record_discovery.DnsRecordDiscoveryHandler
        • Changelog
          • v0.1.3 - 2024-12-05
          • v0.1.2 - 2024-10-04
          • v0.1.1 - 2024-10-03
          • v0.1.0 - 2024-09-26
    • cloudsmith adapter
      • Features
      • Api configuration
      • Example
        • Module cloudsmith
          • Typedefs
          • Entities
          • Resources
            • cloudsmith.entitlement_discovery.EntitlementDiscovery
            • cloudsmith.packages_sync.PackagesSyncResource
            • cloudsmith.resources.entitlement.EntitlementResource
          • Handlers
            • cloudsmith.entitlement_discovery.EntitlementDiscoveryHandler
            • cloudsmith.packages_sync.PackagesSyncResource
            • cloudsmith.resources.entitlement.EntitlementHandler
        • Changelog
          • v0.1.0 - 2025-08-08
          • v0.0.6 - 2024-09-26
          • v0.0.5 - 2024-01-04
          • v0.0.4 - 2023-09-04
          • v0.0.3 - 2023-09-04
          • v0.0.2 - 2023-04-28
    • config module
      • Features
      • Example of usage
        • In the plugin
        • In the config file
        • In the Jinja file
        • In the model
          • Module config
            • Typedefs
            • Plugins
              • config.absolute_path()
              • config.get_config_template_value()
              • config.get_config_template_value_as_bool()
              • config.get_config_template_value_as_int()
              • config.get_config_template_value_as_number()
              • config.get_config_template_value_as_string()
              • config.get_config_value()
              • config.get_config_value_as_bool()
              • config.get_config_value_as_float()
              • config.get_config_value_as_int()
              • config.get_config_value_as_number()
              • config.get_config_value_as_string()
              • config.get_const()
              • config.get_template_value()
              • config.get_template_value_as_bool()
              • config.get_template_value_as_float()
              • config.get_template_value_as_int()
              • config.get_template_value_as_string()
              • config.json_dumps()
              • config.json_loads()
              • config.resolve_path()
          • Changelog
            • v0.7.0 - 2025-10-01
            • v0.6.0 - 2025-07-16
            • v0.5.1 - 2024-12-05
            • v0.5.0 - 2024-10-31
            • v0.4.0 - 2024-09-26
            • v0.3.0 - 2024-01-08
            • v0.2.0 - 2023-11-28
            • v0.1.0 - 2023-11-08
            • v0.0.4 - 2023-03-31
            • v0.0.3 - 2022/11/30
            • v0.0.2 - 2022/11/29
            • v0.0.1 - 2022/11/29
    • connect module
      • Services
      • Features
      • Configuration
        • Module connect
          • Typedefs
          • Entities
          • Implementations
          • Plugins
            • connect.all_l2_connections()
            • connect.allocate_dia_p2p_network()
            • connect.allocate_l3vpn_p2p_network_v4()
            • connect.allocate_l3vpn_p2p_network_v6()
            • connect.allocate_value()
            • connect.cisco_mtu()
            • connect.convert_juniper_bandwith_value()
            • connect.dedup()
            • connect.delete_file()
            • connect.determine_mac()
            • connect.determine_mep_id()
            • connect.enumerate()
            • connect.format()
            • connect.get_allocated_lag_id()
            • connect.get_cisco_policy_rate()
            • connect.get_config()
            • connect.get_documentation_data()
            • connect.get_embedded_entity_state()
            • connect.get_first_free_integer()
            • connect.get_instance_details_url()
            • connect.get_netbox_link_for_interface()
            • connect.get_network_element()
            • connect.get_node_inner_vlan()
            • connect.get_node_outer_vlan()
            • connect.get_node_side_mapping()
            • connect.get_optional()
            • connect.get_peer_endpoint()
            • connect.get_port_id()
            • connect.get_provider_ip()
            • connect.get_provider_ips()
            • connect.get_service_state_option()
            • connect.get_the_first_cir()
            • connect.get_the_first_vlan()
            • connect.get_uni_dict()
            • connect.get_uni_service_usage()
            • connect.gt()
            • connect.is_nokia_bug()
            • connect.kbps_bandwidth()
            • connect.lists_intersection()
            • connect.mac_address_cisco()
            • connect.mac_address_ietf()
            • connect.max_length()
            • connect.maximum_one_vlan_id_or_raise()
            • connect.nokia_port_tag()
            • connect.parse_vlan_tagging()
            • connect.port_encapsulation()
            • connect.qinq_mark_top_only()
            • connect.range()
            • connect.register_fnt_inventory()
            • connect.register_inmanta_inventory()
            • connect.register_netbox_inventory()
            • connect.select_backend_type()
            • connect.select_port()
            • connect.send_file()
            • connect.serialize_vlan_tagging()
            • connect.slugify()
            • connect.string_to_alfanum_with_underscore()
            • connect.unknown_device_kind_error()
            • connect.unsupported_device_kind_error()
            • connect.validate()
            • connect.validate_consistency()
            • connect.validate_next()
            • connect.validate_uni_deletion_dia()
            • connect.validate_uni_deletion_l2connect()
            • connect.validate_uniqueness()
            • connect.validate_vlan_uniqueness()
          • Resources
            • connect.wait_resource.ExternalWait
          • Handlers
            • connect.wait_resource.ExternalWaitHandler
        • Changelog
          • v3.0.1 - 2025-10-31
          • v3.0.0 - 2025-10-24
          • v2.9.0 - 2025-03-18
          • v2.8.0 - 2025-02-10
          • v2.7.1 - 2025-01-09
          • v2.7.0 - 2025-01-08
          • v2.6.5 - 2024-11-12
          • v2.6.4 - 2024-10-04
          • v2.6.3 - 2024-09-26
          • v2.6.2 - 2024-09-17
          • v2.6.1 - 2024-07-23
          • v2.6.0 - 2024-05-28
          • v2.5.3 - 2024-02-15
          • v2.5.2 - 2024-01-03
          • v2.5.1 - 2023-11-15
          • v2.5.0 - 2023-11-14
          • v2.4.1 - 2023-11-10
          • v2.4.0 - 2023-11-08
          • v2.3.1 - 2023-10-19
          • v2.3.0 - 2023-10-16
          • v2.2.0 - 2023-07-07
          • v2.1.1 - 2023-05-16
          • v2.1.0 - 2023-04-04
          • v2.0.0 - 2022/12/16
          • v1.9.2 - 2022/10/18
          • v1.9.1 - 2022/10/04
          • v1.9.0 - 2022/09/20
          • v1.8.0 - (2022/07/15)
          • v1.7.0 - (2022/05/12)
          • v1.6.0 - 2022/03/01
          • v1.5.1 - 2022/03/01
          • v1.5.0 - 2022/03/01
          • v1.4.0 - 2022/02/24
          • v1.3.0 - 2022/02/22
          • v1.2.0 - 2022/02/21
          • v1.1.0 - 2022/02/10
          • v1.0.1 - 2022/01/25
          • v1.0.0 - 2022/01/25
    • devtools module
      • Debug output from the model
        • Test debugging
      • Mocking out handlers
        • Module devtools
          • Plugins
        • Changelog
          • v0.2.0 - 2025-05-21
          • v0.1.0 - 2025-04-03
          • v0.0.3 - 2024-10-31
          • v0.0.2 - 2024-09-26
    • dzs adapter
      • Running tests
    • ecx_l2 adapter
      • Configuration
        • Handler configuration
        • Test credentials
      • Docs
        • Module ecx_l2
          • Typedefs
          • Entities
          • Implementations
          • Plugins
            • ecx_l2.get_equinix_response_error()
            • ecx_l2.get_process_response()
            • ecx_l2.validate_ecx_connection_state_set()
          • Resources
            • ecx_l2.Connection
            • ecx_l2.ConnectionState
          • Handlers
            • ecx_l2.ConnectionHandler
            • ecx_l2.ConnectionStateHandler
        • Changelog
          • v1.4.5 - 2024-10-04
          • v1.4.4 - 2024-09-25
          • v1.4.3 - 2024-09-25
          • v1.4.2 - 2022/09/13
          • v1.4.1 - 2021/05/20
          • v1.4.0 - 2021/05/11
          • v1.3.1 - 2021/02/05
          • v1.3.0 - 2021/02/04
          • v1.2.1 - 2020/10/23
          • v1.2.0 - 2020/09/14
          • V1.1.0 - 2020/07/06
          • V1.0.0 - 2020/05/18
          • V0.1.0 - 2020/05/11
    • exec adapter
      • Features
      • Usage example
        • Module exec
          • Entities
          • Implementations
          • Plugins
            • exec.in_shell()
            • exec.shlex_join()
          • Resources
            • exec.Run
          • Handlers
            • exec.PosixRunHandler
        • Changelog
          • v2.1.1 - 2025-08-08
          • v2.1.0 - 2024-09-18
          • v2.0.0 - 2024-08-03
          • v1.1.22 - 2024-07-05
          • v1.1.21 - 2024-03-29
          • v1.1.20 - 2023-12-08
          • v1.1.19 - 2023-10-12
          • v1.1.18 - 2023-06-30
          • v1.1.17 - 2023-04-04
          • v1.1.16 - 2023-04-04
          • v1.1.10
          • v1.1.9
          • v1.1.4
          • v1.1.3
    • fnt adapter
      • Using the fnt module
      • Generating more entities
        • Module fnt
          • Typedefs
          • Entities
          • Implementations
          • Resources
            • fnt.resources.entity.EntityResource
            • fnt.resources.publish_planning_protocol.PublishPlanningProtocolResource
            • fnt.resources.service.ServiceResource
            • fnt.resources.generated_entity.BearerResource
            • fnt.resources.generated_entity.CVlanResource
            • fnt.resources.generated_entity.CellResource
            • fnt.resources.generated_entity.ChassisInCabinetResource
            • fnt.resources.generated_entity.ChassisInZoneResource
            • fnt.resources.generated_entity.LogicalPortSupportType1Resource
            • fnt.resources.generated_entity.LogicalPortSupportType2Resource
            • fnt.resources.generated_entity.LogicalPortSupportType3Resource
            • fnt.resources.generated_entity.ModuleInSlot
            • fnt.resources.generated_entity.NetworkElementResource
            • fnt.resources.generated_entity.NetworkFunctionResource
            • fnt.resources.generated_entity.SVlanResource
            • fnt.resources.generated_entity.ServerInCabinetResource
            • fnt.resources.generated_entity.ServerInZoneResource
            • fnt.resources.generated_entity.ServiceAssetResource
            • fnt.resources.generated_entity.ServiceSamResource
            • fnt.resources.generated_entity.ServiceTelcoPathResource
            • fnt.resources.generated_entity.ServiceTelcoPathPacketDataResource
            • fnt.resources.generated_entity.ServiceTelcoUnroutedPathResource
            • fnt.resources.generated_entity.ServiceTypeBearerPdResource
            • fnt.resources.generated_entity.ServiceTypePathPdResource
            • fnt.resources.generated_entity.TopZoneResource
            • fnt.resources.generated_entity.VirtualServerResource
            • fnt.resources.generated_entity.VlanPoolResource
          • Handlers
            • fnt.resources.entity.EntityHandler
            • fnt.resources.service.ServiceHandler
            • fnt.resources.generated_entity.GeneratedEntityHandler
            • fnt.resources.generated_entity.GeneratedServiceEntityHandler
            • fnt.resources.publish_planning_protocol.PublishPlanningProtocolHandler
        • Changelog
          • v2.1.1 - 2025-04-23
          • v2.1.0 - 2025-04-23
          • v2.0.3 - 2024-09-26
          • v2.0.2 - 2024-09-05
          • v2.0.1 - 2024-07-05
          • v2.0.0 - 2024-04-15
          • v1.1.0 - 2024-02-20
          • v1.0.1 - 2023-12-21
          • v1.0.0 - 2023-09-26
    • fortigate adapter
      • Features
      • Environment variables
      • Usage example
        • Module fortigate
          • Typedefs
          • Entities
          • Implementations
          • Resources
            • fortigate.resources.firewall.address.AddressResource
            • fortigate.resources.firewall.address6.Address6Resource
            • fortigate.resources.firewall.addrgrp.AddressGroupResource
            • fortigate.resources.firewall.addrgrp6.AddressGroup6Resource
            • fortigate.resources.router.bgp.BGPResource
            • fortigate.resources.firewall.dos_policy.DosPolicyResource
            • fortigate.resources.firewall.dos_policy6.DosPolicy6Resource
            • fortigate.resources.system.interface.InterfaceResource
            • fortigate.resources.vpn.ipsec_phase1_interface.IpSecPhase1InterfaceResource
            • fortigate.resources.vpn.ipsec_phase2_interface.IpSecPhase2InterfaceResource
            • fortigate.resources.system.license.LicenceResource
            • fortigate.resources.firewall.local_in_policy.LocalInPolicyResource
            • fortigate.resources.firewall.local_in_policy6.LocalInPolicy6Resource
            • fortigate.resources.firewall.multicast_policy.MulticastPolicyResource
            • fortigate.resources.firewall.multicast_policy6.MulticastPolicy6Resource
            • fortigate.resources.firewall.policy.PolicyResource
            • fortigate.resources.router.prefix_list.PrefixListResource
            • fortigate.resources.system.sdwan.SDWanResource
            • fortigate.resources.system.settings.SettingsResource
            • fortigate.resources.firewall.shaping_policy.ShapingPolicyResource
            • fortigate.resources.router.static_route.StaticResource
            • fortigate.resources.router.static_route6.Static6Resource
            • fortigate.resources.system.admin.SystemAdminResource
            • fortigate.resources.system.vdom.VdomResource
            • fortigate.resources.system.vdom_link.VdomLinkResource
            • fortigate.resources.firewall.dos_policy_range.DosPolicy6RangeResource
            • fortigate.resources.firewall.dos_policy_range.DosPolicyRangeResource
            • fortigate.resources.firewall.local_in_policy_range.LocalInPolicy6RangeResource
            • fortigate.resources.firewall.local_in_policy_range.LocalInPolicyRangeResource
            • fortigate.resources.firewall.multicast_policy_range.MulticastPolicy6RangeResource
            • fortigate.resources.firewall.multicast_policy_range.MulticastPolicyRangeResource
            • fortigate.resources.firewall.policy_range.PolicyRangeResource
            • fortigate.resources.firewall.shaping_policy_range.ShapingPolicyRangeResource
            • fortigate.resources.router.static_route_range.Static6RangeResource
            • fortigate.resources.router.static_route_range.StaticRangeResource
            • fortigate.resources.fortiflex.entitlements.EntitlementResource
            • fortigate.resources.fortiflex.configuration.FortiGateConfigurationResource
            • fortigate.resources.fortiflex.configuration.FortiManagerConfigurationResource
          • Handlers
            • fortigate.resources.firewall.address.AddressHandler
            • fortigate.resources.firewall.address6.Address6Handler
            • fortigate.resources.firewall.addrgrp.AddressGroupHandler
            • fortigate.resources.firewall.addrgrp6.AddressGroup6Handler
            • fortigate.resources.firewall.dos_policy.DosPolicyHandler
            • fortigate.resources.firewall.dos_policy6.DosPolicy6Handler
            • fortigate.resources.firewall.local_in_policy.LocalInPolicyHandler
            • fortigate.resources.firewall.local_in_policy6.LocalInPolicy6Handler
            • fortigate.resources.firewall.multicast_policy.MulticastPolicyHandler
            • fortigate.resources.firewall.multicast_policy6.MulticastPolicy6Handler
            • fortigate.resources.firewall.policy.PolicyHandler
            • fortigate.resources.firewall.shaping_policy.ShapingPolicyHandler
            • fortigate.resources.router.bgp.BGPHandler
            • fortigate.resources.router.prefix_list.PrefixListHandler
            • fortigate.resources.router.static_route.StaticHandler
            • fortigate.resources.router.static_route6.Static6Handler
            • fortigate.resources.system.admin.SystemAdminHandler
            • fortigate.resources.system.interface.InterfaceHandler
            • fortigate.resources.system.license.LicenceHandler
            • fortigate.resources.system.sdwan.SDWanHandler
            • fortigate.resources.system.settings.SettingsHandler
            • fortigate.resources.system.vdom.VdomHandler
            • fortigate.resources.system.vdom_link.VdomLinkHandler
            • fortigate.resources.vpn.ipsec_phase1_interface.IpSecPhase1InterfaceHandler
            • fortigate.resources.vpn.ipsec_phase2_interface.IpSecPhase2InterfaceHandler
            • fortigate.resources.fortiflex.configuration.FlexConfigurationHandler
            • fortigate.resources.fortiflex.entitlements.EntitlementHandler
            • fortigate.resources.firewall.policy_range.PolicyRangeRangeHandler
            • fortigate.resources.firewall.local_in_policy_range.LocalInPolicyRangeHandler
            • fortigate.resources.router.static_route_range.StaticRangeHandler
        • Changelog
          • v1.0.4 - 2025-05-26
          • v1.0.3 - 2024-11-25
          • v1.0.2 - 2024-11-18
          • v1.0.1 - 2024-09-26
          • v1.0.0 - 2024-08-28
          • v0.4.2 - 2024-07-23
          • v0.4.1 - 2024-07-16
          • v0.4.0 - 2024-06-24
          • v0.3.4 - 2024-05-28
          • v0.3.3 - 2024-05-16
          • v0.3.2 - 2024-05-07
          • v0.3.1 - 2024-04-23
          • v0.3.0 - 2024-04-15
          • v0.2.0 - 2024-02-23
          • v0.1.1 - 2024-01-16
          • v0.1.0 - 2023-11-27
          • v0.0.1 - 2023-08-29
    • fs adapter
      • Features
      • Usage examples
        • Json files
          • Module fs
            • Typedefs
            • Entities
            • Implementations
            • Plugins
              • fs.file()
              • fs.list_files()
              • fs.source()
            • Resources
              • fs.resources.Directory
              • fs.resources.File
              • fs.json_file.JsonFileResource
              • fs.resources.Symlink
            • Handlers
              • fs.resources.PosixFileProvider
              • fs.resources.DirectoryHandler
              • fs.resources.SymlinkProvider
              • fs.json_file.JsonFileHandler
          • Changelog
            • v1.1.1 - 2024-11-28
            • v1.1.0 - 2024-10-04
            • v1.0.1 - 2024-09-17
            • v1.0.0 - 2024-07-29
            • v0.0.1 - 2024-05-22
    • gcp_interco adapter
      • Overview
        • Sides
        • Activation
        • States
      • InterconnectAttachmentHandler
        • Read
        • Create
        • Update
        • Delete
      • InterconnectAttachmentStateHandler
      • Examples
      • Tests
      • External documentation
        • Module gcp_interco
          • Typedefs
          • Entities
          • Implementations
          • Plugins
            • gcp_interco.validate_gcp_state_set()
            • gcp_interco.validate_pairing_key()
            • gcp_interco.validate_region()
          • Resources
            • gcp_interco.InterconnectAttachment
            • gcp_interco.InterconnectAttachmentState
          • Handlers
            • gcp_interco.InterconnectAttachmentHandler
            • gcp_interco.InterconnectAttachmentStateHandler
        • Changelog
          • v1.7.1 - 2024-09-27
          • v1.7.0 - 2024-09-10
          • v1.6.0 - 2023-12-15
          • v1.5.1 - 2023-05-17
          • V1.5.0 - 2023/05/16
          • V1.4.1 - 2022/08/19
          • V1.4.0 - 2022/07/11
          • V1.3.1 - 2021/08/11
          • V1.3.0 - 2021/06/30
          • V1.2.2 - 2021/05/20
          • V1.2.1 - 2021/02/04
          • V1.2.0 - 2020/10/23
          • V1.1.0 - 2020/09/14
          • V1.0.0 - 2020/06/06
          • V0.1.0 - 2020/05/11
    • Graph module
      • Class Diagrams
      • Diagram definition
      • Settings
      • Graph Filter format
        • Entity type
        • Entity relations
          • Module graph
            • Entities
          • Changelog
            • v1.0.1 - 2024-10-04
            • v1.0.0 - 2024-08-19
            • v0.8.13 - 2023-04-27
            • V0.8.7
            • V0.8.6
            • V0.8.4
    • juniper_ex adapter
      • Features
      • Requirements
      • Environment variables
      • Usage example
        • Module juniper_ex
          • Typedefs
          • Entities
          • Implementations
        • Changelog
          • v22.3.11 - 2025-10-07
          • v22.3.10 - 2025-08-08
          • v22.3.9 - 2025-02-11
          • v22.3.8 - 2024-11-18
          • v22.3.7 - 2024-07-17
          • v22.3.6 - 2024-05-06
          • v22.3.5 - 2023-11-27
          • v22.3.4 - 2023-03-17
          • v22.3.3 - 2023-03-17
    • juniper_mx adapter
      • Features
      • Requirements
      • Environment variables
      • Usage example
        • Module juniper_mx
          • Typedefs
          • Entities
          • Implementations
        • Changelog
          • v23.1.7 - 2025-10-08
          • v23.1.6 - 2025-08-08
          • v23.1.5 - 2025-02-11
          • v23.1.4 - 2024-12-05
          • v23.1.3 - 2024-10-31
          • v23.1.2 - 2024-07-17
          • v23.1.1 - 2024-05-06
          • v23.1.0 - 2024-04-10
          • v18.4.6 - 2024-02-23
          • v18.4.5 - 2023-11-27
          • v18.4.4 - 2023-03-17
    • juniper_srx adapter
      • Features
      • Requirements
      • Environment variables
      • Usage example
        • Module juniper_srx
          • Typedefs
          • Entities
          • Implementations
        • Changelog
          • v23.2.4 - 2025-10-08
          • v23.2.3 - 2025-08-08
          • v23.2.2 - 2025-02-11
          • v23.2.1 - 2025-01-08
          • v23.2.0 - 2024-11-21
    • kubernetes adapter
      • Module kubernetes
        • Typedefs
        • Entities
        • Implementations
        • Plugins
          • kubernetes.assert_common_cluster()
        • Resources
          • kubernetes.resources.cluster_role_resource.ClusterRoleResource
          • kubernetes.resources.cluster_role_binding_resource.ClusterRoleBindingResource
          • kubernetes.resources.config_map_resource.ConfigMapResource
          • kubernetes.resources.deployment_resource.DeploymentResource
          • kubernetes.resources.namespace_resource.NamespaceResource
          • kubernetes.resources.role_resource.NamespacedRoleResource
          • kubernetes.resources.role_binding_resource.NamespacedRoleBindingResource
          • kubernetes.resources.pod_resource.PodResource
          • kubernetes.resources.secret_resource.SecretResource
          • kubernetes.resources.service_resource.ServiceResource
          • kubernetes.resources.service_account_resource.ServiceAccountResource
          • kubernetes.resources.stateful_set_resource.StatefulSetResource
        • Handlers
          • kubernetes.resources.cluster_role_binding_resource.ClusterRoleBindingResourceProvider
          • kubernetes.resources.cluster_role_resource.ClusterRoleResourceProvider
          • kubernetes.resources.config_map_resource.ConfigMapResourceProvider
          • kubernetes.resources.deployment_resource.DeploymentResourceProvider
          • kubernetes.resources.namespace_resource.NamespaceResourceProvider
          • kubernetes.resources.pod_resource.PodResourceProvider
          • kubernetes.resources.role_binding_resource.NamespacedRoleBindingResourceProvider
          • kubernetes.resources.role_resource.NamespacedRoleResourceProvider
          • kubernetes.resources.secret_resource.SecretResourceProvider
          • kubernetes.resources.service_account_resource.ServiceAccountResourceProvider
          • kubernetes.resources.service_resource.ServiceResourceProvider
          • kubernetes.resources.stateful_set_resource.StatefulSetResourceProvider
      • Changelog
        • v0.0.4 - 2024-10-04
        • v0.0.3 - 2024-10-03
        • v0.0.2 - 2024-07-23
    • lsm module
      • Example
      • Environment Variables
        • Module lsm
          • Typedefs
          • Entities
          • Implementations
          • Plugins
            • lsm.all()
            • lsm.context_v2_unwrapper()
            • lsm.current_state()
            • lsm.format()
            • lsm.fsm_to_dot()
            • lsm.get_previous_attributes()
            • lsm.get_previous_value()
            • lsm.get_service_binding_version()
            • lsm.has_current_state()
            • lsm.insert_embedded_entities_id()
            • lsm.insert_purged_embedded_entities()
            • lsm.is_validating()
            • lsm.render_dot()
            • lsm.set_suggested_values()
            • lsm.update_read_only_attribute()
            • lsm.validate_service_index()
          • Resources
            • lsm.LifecycleTransferResource
            • lsm.ServiceInstanceResource
          • Handlers
            • lsm.LifecycleTransferHandler
            • lsm.ServiceInstanceHandler
        • Changelog
          • v3.1.0 - 2025-10-27
          • v3.0.1 - 2025-09-02
          • v3.0.0 - 2025-08-04
          • v2.34.3 - 2025-08-01
          • v2.34.2 - 2025-07-10
          • v2.34.1 - 2025-07-02
          • v2.34.0 - 2025-06-30
          • v2.33.20 - 2025-04-17
          • v2.33.19 - 2025-04-08
          • v2.33.18 - 2025-03-12
          • v2.33.17 - 2025-03-12
          • v2.33.16 - 2025-03-07
          • v2.33.15 - 2025-03-05
          • v2.33.14 - 2025-02-05 [yanked]
          • v2.33.13 - 2025-02-03
          • v2.33.12 - 2025-01-16
          • v2.33.11 - 2025-01-13
          • v2.33.10 - 2025-01-09
          • v2.33.9 - 2024-12-19
          • v2.33.8 - 2024-12-13
          • v2.33.7 - 2024-12-03
          • v2.33.6 - 2024-11-22
          • v2.33.5 - 2024-11-13
          • v2.33.4 - 2024-10-31
          • v2.33.3 - 2024-10-28
          • v2.33.2 - 2024-10-25
          • v2.33.1 - 2024-10-15
          • v2.33.0 - 2024-10-09
          • v2.32.6 - 2024-10-08 [yanked]
          • v2.32.5 - 2024-10-04 [yanked]
          • v2.32.4 - 2024-10-01 [yanked]
          • v2.32.3 - 2024-09-26 [yanked]
          • v2.32.2 - 2024-09-20 [yanked]
          • v2.32.1 - 2024-09-04 [yanked]
          • v2.32.0 - 2024-08-29 [yanked]
          • v2.31.4 - 2024-08-01
          • v2.31.3 - 2024-07-15
          • v2.31.2 - 2024-07-04
          • v2.31.1 - 2024-07-04
          • v2.31.0 - 2024-07-03 [yanked]
          • v2.30.1 - 2024-06-17
          • v2.30.0 - 2024-05-17
          • v2.29.2 - 2024-05-03
          • v2.29.1 - 2024-04-24
          • v2.29.0 - 2024-04-19
          • v2.28.17 - 2024-04-16
          • v2.28.16 - 2024-04-11
          • v2.28.15 - 2024-04-05
          • v2.28.14 - 2024-04-03
          • v2.28.13 - 2024-03-28
          • v2.28.12 - 2024-03-27
          • v2.28.11 - 2024-03-18
          • v2.28.10 - 2024-03-15
          • v2.28.9 - 2024-03-14
          • v2.28.8 - 2024-03-04
          • v2.28.7 - 2024-02-19
          • v2.28.6 - 2024-02-19
          • v2.28.5 - 2024-02-14
          • v2.28.4 - 2024-02-09
          • v2.28.3 - 2024-01-16
          • v2.28.2 - 2024-01-15
          • v2.28.1 - 2024-01-09
          • v2.28.0 - 2024-01-08
          • v2.27.6 - 2024-01-05
          • v2.27.5 - 2024-01-04
          • v2.27.4 - 2023-12-07
          • v2.27.3 - 2023-12-06
          • v2.27.2 - 2023-12-05
          • v2.27.1 - 2023-12-01
          • v2.27.0 - 2023-12-01
          • v2.26.0 - 2023-11-16
          • v2.25.5 - 2023-11-02
          • v2.25.4 - 2023-10-31
          • v2.25.3 - 2023-10-30
          • v2.25.2 - 2023-10-27
          • v2.25.1 - 2023-10-17
          • v2.25.0 - 2023-10-17
          • v2.24.1 - 2023-10-12
          • v2.24.0 - 2023-10-11
          • v2.23.1 - 2023-10-11
          • v2.23.0 - 2023-08-16
          • v2.22.13 - 2023-08-10
          • v2.22.12 - 2023-08-08
          • v2.22.11 - 2023-08-02
          • v2.22.10 - 2023-07-25
          • v2.22.9 - 2023-07-05
          • v2.22.8 - 2023-06-30
          • v2.22.7 - 2023-06-28
          • v2.22.6 - 2023-06-27
          • v2.22.5 - 2023-06-22
          • v2.22.4 - 2023-06-15
          • v2.22.3 - 2023-06-05
          • v2.22.2 - 2023-05-31
          • v2.22.1 - 2023-05-08
          • v2.22.0 - 2023-04-21
          • v2.21.5 - 2023-04-13
          • v2.21.4 - 2023-04-04
          • v2.21.3 - 2023-04-03
          • v2.21.2 - 2023-03-29
          • v2.21.1 - 2023-03-28
          • v2.21.0 - 2023-03-08
          • v2.20.3 - 2023-02-03
          • v2.20.2 - 2023-02-02
          • v2.19.13
          • v2.19.12
          • v2.19.11
          • v2.19.10
          • v2.19.9
          • v2.19.8
          • v2.19.7
          • v2.19.6
          • v2.19.3
          • v2.19.2
          • v2.19.1
          • v2.19.0
          • v2.18.8
          • v2.18.7
          • v2.18.5
          • v2.18.4
          • v2.18.3
          • v2.18.1
          • v2.18.0
          • v2.17.2
          • v2.17.1
          • v2.17.0
          • v2.16.2
          • v2.16.1
          • v2.16.0
          • v2.15.0
          • v2.14.2
          • v2.14.1
          • v2.14.0
          • v2.13.2
          • v2.13.0
          • v2.12.5
          • v2.12.2
          • v2.12.1
          • v2.12.0
          • v2.11.0
          • v2.10.0
          • v2.9.5
          • v2.9.4
          • v2.9.3
          • v2.9.2
          • v2.9.1
          • v2.9.0
          • v2.8.3
          • v2.8.2
          • v2.8.1
          • v2.8.0
          • v2.7.3
          • v2.7.2
          • v2.7.1
          • v2.7.0
          • v2.6.2
          • v2.6.1
          • v2.6.0
          • v2.5.0
          • v2.4.10
          • v2.4.9
          • v2.4.8
          • v2.4.7
          • v2.4.6
          • v2.4.5
          • v2.4.4
          • v2.4.3
          • v2.4.2
          • v2.4.1
          • v2.4.0
          • v2.3.2
          • v2.3.1
          • v2.3.0
          • v2.2.21
          • v2.2.20
          • v2.2.19
          • v2.2.18
          • v2.2.17
          • v2.2.16
          • v2.2.15
          • v2.2.14
          • v2.2.13
          • v2.2.10
          • v2.2.7
          • v2.2.6
          • v2.2.5
          • v2.2.2
          • v2.2.1
          • v2.2.0
          • v2.1.0
          • v2.0.3
          • v2.0.2
          • v2.0.1
          • v2.0.0
          • v1.6.1
          • v1.6.0
          • v1.5.1
          • v1.5.0
          • v1.4.0
          • v1.3.1
          • v1.3.0
          • v1.2.2
          • v1.2.1
          • v1.2.0
          • v1.1.1
          • v1.1.0
          • v1.0.1
    • mikrotik adapter
      • Usage example
    • mitogen base module
      • Environment variables
      • Exceptions
        • Module mitogen
          • Entities
        • Changelog
          • v0.2.4 - 2025-10-14
          • v0.2.3 - 2025-02-11
          • v0.2.2 - 2024-12-18
          • v0.2.1 - 2024-10-04
          • v0.2.0 - 2024-09-17
          • v0.1.0 - 2024-08-06
          • v0.0.1 - 2024-07-22
    • n5k_lan adapter
      • Available Environment Variables
      • Example
        • Module n5k_lan
          • Typedefs
          • Entities
          • Implementations
          • Plugins
            • n5k_lan.switchport_vlan_list_by_purged()
          • Resources
            • n5k_lan.Resource
          • Handlers
            • n5k_lan.ResourceHandler
        • Changelog
          • v1.4.4 - 2024-10-04
          • v1.4.3 - 2024-10-04
          • v1.4.2 - 2024-09-25
          • v1.4.1 - 2024-09-25
          • v1.4.0 - 2024-02-20
          • v1.3.2 - 2023-11-09
          • v1.3.1 - 2023-06-16
          • v1.3.0 - 2023-05-25
          • v1.2.2 - 2023-05-17
          • 1.2.1
          • 1.2.0
          • 1.1.2
          • 1.1.1
          • 1.1.0
          • 1.0.1
          • 1.0.0
        • Developer Docs
          • Running tests
          • Design
          • Schema documentation
    • netbox adapter
      • Features
      • Environment variables
      • Netbox-Secret
      • Usage example
        • Module netbox
          • Typedefs
          • Entities
          • Implementations
          • Plugins
            • netbox.build_secret_reference()
            • netbox.create_secret_reference()
            • netbox.get()
            • netbox.get_by_id()
            • netbox.get_or_create_secret_role()
            • netbox.get_or_generate_password()
            • netbox.list()
          • Resources
            • netbox.resources.PrimaryIPResource
            • netbox.resources.ClusterResource
            • netbox.resources.ClusterGroupResource
            • netbox.resources.ClusterTypeResource
            • netbox.resources.ConfigTemplateResource
            • netbox.resources.CustomFieldResource
            • netbox.resources.CustomFieldChoiceSetResource
            • netbox.resources.DataSourceResource
            • netbox.resources.DeviceResource
            • netbox.resources.DeviceRoleResource
            • netbox.resources.DeviceTypeResource
            • netbox.resources.IPAddressResource
            • netbox.resources.InterfaceResource
            • netbox.resources.InterfaceCableResource
            • netbox.resources.L2VPNResource
            • netbox.resources.L2VPNTerminationResource
            • netbox.resources.LocationResource
            • netbox.resources.ManufacturerResource
            • netbox.resources.ModuleResource
            • netbox.resources.ModuleBayResource
            • netbox.resources.ModuleTypeResource
            • netbox.resources.PlatformResource
            • netbox.resources.PrefixResource
            • netbox.resources.PrefixAndVlanRoleResource
            • netbox.resources.RackResource
            • netbox.resources.RackRoleResource
            • netbox.resources.RackTypeResource
            • netbox.resources.RegionResource
            • netbox.resources.SiteResource
            • netbox.resources.SiteGroupResource
            • netbox.resources.TagResource
            • netbox.resources.TenantResource
            • netbox.resources.TenantGroupResource
            • netbox.resources.VMInterfaceResource
            • netbox.resources.VRFResource
            • netbox.resources.VirtualChassisResource
            • netbox.resources.VirtualMachineResource
            • netbox.resources.VlanResource
            • netbox.resources.VlanGroupResource
          • Handlers
            • netbox.resources.BaseNetboxHandler
            • netbox.resources.InterfaceCableHandler
            • netbox.resources.PrimaryIPHandler
        • Changelog
          • v4.4.0 - 2025-10-02
          • v4.3.1 - 2025-08-08
          • v4.3.0 - 2025-05-02
          • v4.2.0 - 2025-04-23
          • v4.1.0 - 2025-02-07
          • v3.7.4 - 2024-12-20
          • v3.7.3 - 2024-11-18
          • v3.7.2 - 2024-10-21
          • v3.7.1 - 2024-07-11
          • v3.7.0.1 - 2024-06-12
          • v0.5.5 - 2024-06-06
          • v0.5.4 - 2024-05-16
          • v0.5.3 - 2024-05-07
          • v0.5.2 - 2024-04-25
          • v0.5.1 - 2024-04-24
          • v0.5.0 - 2024-04-22
          • v0.4.0 - 2024-03-11
          • v0.3.0 - 2024-02-20
          • v0.2.1 - 2024-01-05
          • v0.2.0 - 2023-11-27
          • v0.1.2 - 2023-07-14
          • v0.1.1 - 2023-07-14
          • v0.1.0 - 2023-05-16
          • v0.0.1 - 2022/12/16
    • nfmp Module
      • Running tests
    • nokia_srlinux adapter
      • Features
      • Usage example
        • Module nokia_srlinux
          • Typedefs
          • Entities
          • Implementations
        • Changelog
          • v24.10.2 - 2025-10-08
          • v24.10.1 - 2025-08-08
          • v24.10.0 - 2025-04-15
          • v23.10.4 - 2025-02-11
          • v23.10.3 - 2024-12-05
          • v23.10.2 - 2024-09-27
          • v23.10.1 - 2024-07-17
          • v23.10.0 - 2023-11-30
          • v21.11.4 - 2023-11-27
          • v21.11.3 - 2023-03-20
    • nokia_sros adapter
      • Features
      • Usage example
        • Module nokia_sros
          • Typedefs
          • Entities
          • Implementations
          • Resources
            • nokia_sros.eth_cfm_state.EthCFMStateResource
          • Handlers
            • nokia_sros.eth_cfm_state.EthCFMStateHandler
        • Changelog
          • v24.10.2 - 2025-10-08
          • v24.10.1 - 2025-08-08
          • v24.10.0 - 2025-06-12
          • v23.10.5 - 2025-02-11
          • v23.10.4 - 2024-11-28
          • v23.10.3 - 2024-09-26
          • v23.10.2 - 2024-07-17
          • v23.10.1 - 2024-03-19
          • v23.10.0 - 2024-02-08
          • v22.10.1 - 2023-10-11
          • v22.10.0
    • oci_fastconnect adapter
      • Features
      • Usage example
        • Module oci_fastconnect
          • Typedefs
          • Entities
          • Implementations
          • Resources
            • oci_fastconnect.virtual_circuit.VirtualCircuitResource
            • oci_fastconnect.virtual_circuit.VirtualCircuitStateCheckResource
          • Handlers
            • oci_fastconnect.virtual_circuit.VirtualCircuitHandler
            • oci_fastconnect.virtual_circuit.VirtualCircuitStateCheckHandler
        • Changelog
          • v0.1.3 - 2025-08-08
          • v0.1.2 - 2024-11-04
          • v0.1.1 - 2024-09-26
          • v0.1.0 - 2023-12-01
    • openstack adapter
      • How to use it
        • Prerequisites
        • Creating machines
        • Getting the agent on the machine
        • Pushing resources to the machine
        • Actual usage
          • Module openstack
            • Typedefs
            • Entities
            • Implementations
            • Plugins
              • openstack.find_flavor()
              • openstack.find_image()
            • Resources
              • openstack.EndPoint
              • openstack.Flavor
              • openstack.FloatingIP
              • openstack.HostPort
              • openstack.Image
              • openstack.Network
              • openstack.Project
              • openstack.Role
              • openstack.Router
              • openstack.RouterPort
              • openstack.SecurityGroup
              • openstack.Service
              • openstack.Subnet
              • openstack.User
              • openstack.VirtualMachine
            • Handlers
              • openstack.FlavorHandler
              • openstack.ImageHandler
              • openstack.VirtualMachineHandler
              • openstack.NetworkHandler
              • openstack.RouterHandler
              • openstack.SubnetHandler
              • openstack.RouterPortHandler
              • openstack.HostPortHandler
              • openstack.SecurityGroupHandler
              • openstack.FloatingIPHandler
              • openstack.ProjectHandler
              • openstack.UserHandler
              • openstack.RoleHandler
              • openstack.ServiceHandler
              • openstack.EndpointHandler
          • Changelog
            • v4.0.8 - 2024-11-12
            • v4.0.7 - 2024-10-04
            • v4.0.6 - 2024-07-12
            • v4.0.5 - 2024-07-05
            • v4.0.4 - 2024-03-29
            • v4.0.3 - 2024-02-14
            • v4.0.2 - 2023-12-11
            • v4.0.1 - 2023-12-07
            • 4.0.0 - 2023-12-07
            • v3.8.12 - 2023-10-12
            • v3.8.11 - 2023-06-30
            • v3.8.10 - 2023-05-08
            • v3.8.9 - 2023-04-04
            • v3.8.8 - 2023-04-04
            • v3.8.7 - 2023-02-02
            • v3.8.6 - 2023-02-02
            • 3.8.3
            • 3.7.11
            • 3.7.10
            • 3.7.7
            • 3.7.5
            • 3.7.3
            • 3.7.2
            • 3.7.1
            • 3.7.0
            • 3.6.13
            • 3.6.12
            • 3.6.11
            • 3.6.10
            • 3.6.9
            • 3.6.8
            • 3.6.7
            • 3.6.6
            • 3.6.5
            • 3.6.4
            • 3.6.3
            • 3.6.2
            • 3.6.1
            • 3.6.0
            • 3.5.6
            • 3.5.5
            • 3.5.4
            • 3.5.3
            • 3.5.2
            • 3.5.1
            • 3.5.0
            • 3.4.1
            • 3.4.0
            • 3.3.2
            • 3.3.1
            • 3.3.0
            • 3.2.0
            • 3.1.1
    • rest adapter
      • Example
        • Module rest
          • Entities
          • Implementations
          • Resources
            • rest.RESTCall
          • Handlers
            • rest.RESTHandler
        • Changelog
          • v1.0.1 - 2024-10-04
          • v1.0.0 - 2024-08-19
          • v0.2.22 - 2024-07-05
          • v0.2.21 - 2024-03-29
          • v0.2.20 - 2023-12-08
          • v0.2.19 - 2023-10-12
          • v0.2.18 - 2023-06-30
          • v0.2.17 - 2023-05-08
          • v0.2.16 - 2023-04-04
          • v0.2.15 - 2023-04-04
          • v0.2.9
          • v0.2.7
          • v0.2.4
          • v0.2.3
          • v0.2.1
    • restbase base module
      • Disclaimer
        • Module restbase
          • Typedefs
          • Entities
          • Plugins
            • restbase.as_bool()
            • restbase.is_bool()
            • restbase.is_int()
            • restbase.is_number()
            • restbase.validate_type()
        • Changelog
          • v2.4.5 - 2025-09-16
          • v2.4.4 - 2025-08-08
          • v2.4.3 - 2025-02-11
          • v2.4.2 - 2024-11-06
          • v2.4.1 - 2024-10-04
          • v2.4.0 - 2024-08-29
          • v2.3.0 - 2024-07-16
          • v2.2.0 - 2024-07-05
          • v2.1.0 - 2024-06-03
          • v2.0.2 - 2024-04-23
          • v2.0.1 - 2024-03-11
          • v2.0.0 - 2024-02-20
          • v1.6.0 - 2024-01-17
          • v1.5.0 - 2023-11-27
          • v1.4.0 - 2023-08-11
          • v1.3.0 - 2023-04-19
          • v1.2.1 - 2023-02-21
          • v1.2.0 - 2023-02-17
          • v1.1.0 - 2023-02-16
          • v1.0.1 - 2023-02-15
          • v1.0.0 - 2023-02-15
          • v0.1.0 - 2023-02-14
          • v0.0.1 - 2023-02-01
    • SNMP Module
    • std module
      • Features
      • Usage example
        • Module std
          • Typedefs
          • Entities
          • Implementations
          • Plugins
            • std.add_to_ip()
            • std.assert()
            • std.at()
            • std.attr()
            • std.capitalize()
            • std.contains()
            • std.count()
            • std.create_environment_reference()
            • std.create_fact_reference()
            • std.create_int_reference()
            • std.dict_get()
            • std.environment()
            • std.environment_name()
            • std.environment_server()
            • std.equals()
            • std.familyof()
            • std.file()
            • std.filter()
            • std.flatten()
            • std.format()
            • std.generate_password()
            • std.get_env()
            • std.get_env_int()
            • std.getattr()
            • std.getfact()
            • std.hostname()
            • std.inlineif()
            • std.invert()
            • std.ip_address_from_interface()
            • std.ipindex()
            • std.is_base64_encoded()
            • std.is_instance()
            • std.is_unknown()
            • std.isset()
            • std.item()
            • std.json_dumps()
            • std.json_loads()
            • std.key_sort()
            • std.len()
            • std.length()
            • std.limit()
            • std.list_files()
            • std.lower()
            • std.netmask()
            • std.network_address()
            • std.objid()
            • std.password()
            • std.prefixlen()
            • std.prefixlength_to_netmask()
            • std.print()
            • std.replace()
            • std.select()
            • std.sequence()
            • std.server_ca()
            • std.server_port()
            • std.server_ssl()
            • std.server_token()
            • std.source()
            • std.split()
            • std.template()
            • std.timestamp()
            • std.type()
            • std.unique()
            • std.unique_file()
            • std.upper()
            • std.validate_type()
          • Resources
            • std.resources.AgentConfig
            • std.resources.Null
          • Handlers
            • std.resources.NullProvider
            • std.resources.AgentConfigHandler
        • Changelog
          • v8.5.1 - 2025-07-11
          • v8.5.0 - 2025-07-02
          • v8.4.2 - 2025-06-03
          • v8.4.1 - 2025-06-03 (yanked: broke compatibility with Python 3.11)
          • v8.4.0 - 2025-05-02
          • v8.3.2 - 2025-04-08
          • v8.3.1 - 2025-03-14
          • v8.3.0 - 2025-03-12
          • v8.2.3 - 2025-02-06
          • v8.2.2 - 2025-02-03
          • v8.2.1 - 2025-01-23
          • v8.2.0 - 2025-01-21
          • v8.1.0 - 2025-01-16
          • v8.0.0 - 2024-12-12
          • v7.0.0 - 2024-10-14
            • Upgrade procedure
          • v6.1.0 - 2024-10-07
          • v6.0.2 - 2024-10-04
          • v6.0.1 - 2024-09-25
          • v6.0.0 - 2024-08-28
            • Upgrade procedure:
          • v5.2.2 - 2024-07-04
          • v5.2.1 - 2024-03-29
          • v5.2.0 - 2024-03-05
          • v5.1.1 - 2024-02-19
          • v5.1.0 - 2024-01-16
          • v5.0.0 - 2023-12-07
          • v4.4.0 - 2023-12-05
          • v4.3.5 - 2023-11-21
          • v4.3.4 - 2023-11-10
          • v4.3.3 - 2023-11-08
          • v4.3.2 - 2023-10-27
          • v4.3.1 - 2023-10-25
          • v4.3.0 - 2023-10-24
          • v4.2.1 - 2023-10-05
          • v4.2.0 - 2023-09-08
          • v4.1.10 - 2023-09-06
          • v4.1.9 - 2023-08-31
          • v4.1.8 - 2023-06-30
          • v4.1.7 - 2023-04-18
          • v4.1.6 - 2023-04-04
          • v4.1.5 - 2023-03-22
          • v4.1.4 - 2023-03-06
          • v4.1.3 - 2023-02-02
          • v4.1.1 - 2023-01-18
          • v4.1.0 - 2023-01-13
          • v4.0.1
          • v4.0.0
          • v3.1.3
          • v3.1.2
          • v3.1.1
          • v3.1.0
          • v3.0.16
          • v3.0.15
          • v3.0.14
          • v3.0.12
          • v3.0.11
          • v3.0.9
          • v3.0.8
          • v3.0.7
          • v3.0.6
          • v3.0.4
          • v3.0.3
          • v3.0.2
          • v3.0.1
          • v3.0.0
          • v2.1.9
          • v2.1.8
          • v2.1.7
          • v2.1.6
          • v2.1.5
          • v2.1.4
          • v2.1.3
          • v2.1.2
          • v2.1.1
          • v2.1.0
          • v2.0.7
          • v2.0.6
          • v2.0.5
          • v2.0.4
          • v2.0.3
          • v2.0.2
          • v2.0.1
          • v2.0.0
          • v1.5.3
          • v1.5.2
          • v1.5.1
          • v1.5.0
          • v1.4.1
          • v1.4.0
          • v1.2.0
          • v1.1.0
          • v1.0.0
          • v0.26.0
    • systemd adapter
      • Features
      • Usage example
        • Module systemd
          • Typedefs
          • Entities
          • Implementations
          • Resources
            • systemd.Service
          • Handlers
            • systemd.SystemdService
        • Changelog
          • v1.0.2 - 2025-08-08
          • v1.0.1 - 2024-10-04
          • v1.0.0 - 2024-08-28
          • v0.0.3 - 2024-05-10
          • v0.0.2 - 2024-03-21
          • v0.0.1 - 2022-08-15
    • tibit adapter
      • Module tibit
        • Typedefs
        • Entities
        • Implementations
      • Changelog
        • v0.1.5 - 2025-10-01
        • v0.1.4 - 2025-08-08
        • v0.1.3 - 2025-02-11
        • v0.1.2 - 2024-12-05
        • v0.1.1 - 2024-10-04
        • v0.1.0 - 2024-09-26
    • transportpce adapter
      • Module transportpce
        • Entities
        • Implementations
        • Plugins
          • transportpce.get_network()
          • transportpce.get_service()
        • Resources
          • transportpce.service.ServiceResource
          • transportpce.service.ServiceStatusResource
        • Handlers
          • transportpce.service.ServiceHandler
          • transportpce.service.ServiceStatusHandler
      • Changelog
        • v0.0.2 - 2024-10-04
        • v0.0.1 - 2024-09-26
    • vcenter adapter
      • Features
      • Usage example
        • Module vcenter
          • Typedefs
          • Entities
          • Implementations
          • Plugins
            • vcenter._list_first()
            • vcenter._list_tail()
            • vcenter.get_folders_names_hierarchy()
            • vcenter.get_resources_usage()
            • vcenter.validate_iso_in_datastore_name()
          • Resources
            • vcenter.resource.iso.CreateISOResource
            • vcenter.resource.distributed_virtual_portgroup.DistributedVirtualPortgroup
            • vcenter.resource.virtual_machine.ESXIVirtualMachineFromOva
            • vcenter.resource.host_dnsconfig.HostDnsConfig
            • vcenter.resource.host_group.HostGroup
            • vcenter.resource.host_portgroup.HostPortgroup
            • vcenter.resource.host_vnic.HostVirtualNic
            • vcenter.resource.host_vswitch.HostVirtualSwitch
            • vcenter.resource.virtual_machine.RenameVirtualMachineResource
            • vcenter.resource.vmdk_storage_rule.VMDKStorageRule
            • vcenter.unmanaged.VirtualMachineDiscovery
            • vcenter.resource.virtual_disk.VirtualDisk
            • vcenter.resource.virtual_machine.VirtualMachineFromContentLibrary
            • vcenter.resource.virtual_machine.VcenterVirtualMachineFromOva
            • vcenter.resource.virtual_machine.VcenterVirtualMachineFromTemplate
            • vcenter.resource.virtual_machine_group.VirtualMachineGroup
            • vcenter.resource.virtual_machine_storage_rule.VirtualMachineStorageRule
            • vcenter.resource.virtual_machine_to_host_rule.VirtualMachineToHostRule
            • vcenter.resource.virtual_machine_to_virtual_machine_rule.VirtualMachineToVirtualMachineRule
          • Handlers
            • vcenter.handler.virtual_machine.RenameVirtualMachineHandler
            • vcenter.handler.virtual_machine.VcenterVirtualMachineFromTemplateHandler
            • vcenter.handler.virtual_machine.VcenterVirtualMachineFromOvaHandler
            • vcenter.handler.virtual_machine.ESXIVirtualMachineFromOvaHandler
            • vcenter.handler.virtual_machine.VcenterVirtualMachineFromContentLibrary
            • vcenter.unmanaged.VirtualMachineDiscoveryHandler
            • vcenter.handler.distributed_virtual_portgroup.PortGroupHandler
            • vcenter.handler.host_dnsconfig.HostDnsConfigHandler
            • vcenter.handler.host_group.HostGroupHandler
            • vcenter.handler.host_portgroup.HostPortGroupHandler
            • vcenter.handler.host_vnic.HostVirtualNicHandler
            • vcenter.handler.host_vswitch.HostVirtualSwitchHandler
            • vcenter.handler.virtual_machine_storage_rule.VirtualMachineStorageRuleHandler
            • vcenter.handler.virtual_machine_to_host_rule.VirtualMachineToHostRuleHandler
            • vcenter.handler.virtual_machine_to_virtual_machine_rule.VirtualMachineToVirtualMachineRuleHandler
            • vcenter.handler.iso.CreateISOHandler
            • vcenter.handler.virtual_disk.VirtualDiskHandler
            • vcenter.handler.virtual_machine_group.VirtualMachineGroupHandler
            • vcenter.handler.vmdk_storage_rule.VMDKStorageRuleHandler
        • Changelog
          • v4.0.3 - 2025-10-15
          • v4.0.2 - 2025-08-18
          • v4.0.1 - 2025-01-10
          • v4.0.0 - 2024-11-25
          • v3.7.0 - 2024-11-14
          • v3.6.8 - 2024-10-29
          • v3.6.7 - 2024-10-08
          • v3.6.6 - 2024-09-25
          • v3.6.5 - 2024-08-29
          • v3.6.4 - 2024-08-12
          • v3.6.3 - 2024-07-16
          • v3.6.2 - 2024-06-27
          • v3.6.1 - 2024-06-24
          • v3.6.0 - 2024-06-04
          • v3.5.0 - 2024-05-06
          • v3.4.0 - 2024-03-27
          • v3.3.3 - 2024-03-19
          • v3.3.2 - 2024-03-11
          • v3.3.1 - 2024-02-15
          • v3.3.0 - 2024-01-15
          • v3.2.0 - 2023-11-27
          • v3.1.1 - 2023-08-31
          • v3.1.0 - 2023-07-12
          • v3.0.7 - 2023-05-16
          • v3.0.6 - 2023-05-15
          • v3.0.5 - 2023-05-08
          • v3.0.4 - 2023-04-12
          • v3.0.3 - 2023-03-29
          • v3.0.2 - 2023-03-24
          • v3.0.1 - 2023-03-23
          • v3.0.0 - 2023-02-24
          • v2.0.1 - 2023-01-30
          • 2.0.0 - 2022-12-19
          • 1.9.2 (2022/11/25)
          • 1.9.1 (2022/11/15)
          • 1.9.0 (2022/08/24)
          • 1.8.0 (2022/07/14)
          • 1.7.2
          • 1.7.1
          • 1.7.0
          • 1.6.2
          • 1.6.1
          • 1.6.0
          • 1.5.2
          • 1.5.1
          • 1.5.0
          • 1.4.0
          • 1.3.2
          • 1.3.1
          • 1.3.0
          • 1.2.0
          • 1.1.0
          • 1.0.0
    • vyos adapter
      • Usage
        • Module vyos
          • Typedefs
          • Entities
          • Implementations
          • Resources
            • vyos.Config
            • vyos.IpFact
            • vyos.KeyGen
          • Handlers
            • vyos.VyosHandler
            • vyos.KeyGenHandler
            • vyos.IpFactHandler
        • Changelog
          • v3.0.12 - 2024-10-07
          • v3.0.11 - 2024-10-04
          • v3.0.10 - 2024-09-18
          • v3.0.9 - 2024-07-12
          • v3.0.8 - 2024-07-05
          • v3.0.7 - 2024-03-29
          • v3.0.6 - 2023-10-12
          • v3.0.5 - 2023-06-30
          • v3.0.4 - 2023-05-08
          • V2.0.1
          • V2.0.0
          • V1.3.9
          • V1.3.8
          • V1.3.7
          • V1.3.6
          • v1.3.4
          • v1.3.3
          • V1.3.2
          • V1.3.1
          • V1.3.0
          • V1.2.1
          • V1.2.0
          • V1.1.3
          • V1.1.2
          • V1.1.1
    • yaml module
      • Usage example
      • Using this module to load a yaml inventory
        • Module yaml
          • Plugins
            • yaml.load()
            • yaml.loads()
        • Changelog
          • v1.0.0 - 2024-10-04
    • yang base module
      • Building Block Disclaimer
      • Configuration
      • Advanced usage
        • Yin file in-memory caching
        • Experimental diff calculation
        • On-device diff detection during dry run
          • Module yang
            • Typedefs
            • Entities
            • Implementations
            • Plugins
              • yang.as_bool()
              • yang.compiled_modules()
              • yang.deprecation_warning()
              • yang.is_bool()
              • yang.is_float()
              • yang.is_int()
              • yang.is_number()
              • yang.validate_type()
              • yang.warning()
            • Resources
              • yang.resources.YangGnmiResource
              • yang.resources.YangNetconfResource
              • yang.ncverify.resource.NetconfVerifyResource
              • yang.resources.YangResource
            • Handlers
              • yang.gnmi.handler.GnmiHandler
              • yang.netconf.handler.YangHandler
              • yang.ncverify.handler.NetconfVerifyHandler
          • Changelog
            • v3.5.0 - 2025-10-01
            • v3.4.0 - 2025-02-12
            • v3.3.1 - 2024-11-20
            • v3.3.0 - 2024-11-18
            • v3.2.2 - 2024-10-08
            • v3.2.1 - 2024-10-07
            • v3.2.0 - 2024-10-07
            • v3.1.0 - 2024-09-18
            • v3.0.1 - 2024-08-19
            • v3.0.0 - 2024-07-05
            • v2.20.0 - 2024-05-23
            • v2.19.0 - 2024-04-29
            • v2.18.0 - 2024-03-27
            • v2.17.2 - 2024-03-01
            • v2.17.1 - 2024-01-29
            • v2.17.0 - 2024-01-23
            • v2.16.1 - 2024-01-10
            • v2.16.0 - 2023-11-27
            • v2.15.0 - 2023-07-10
            • v2.14.3 - 2023-06-08
            • v2.14.2 - 2023-06-01
            • v2.14.1 - 2023-05-17
            • v2.14.0 - 2023-03-17
            • v2.13.0 - 2023-03-15
            • V2.12.0 - 2022/12/19
            • V2.11.3 - 2022/10/24
            • V2.11.2 - 2022/10/22
            • V2.11.1 - 2022/08/25
            • V2.11.0 - 2022/08/01
            • V2.10.0 - 2022/06/29
            • V2.9.0 - 2022/05/19
            • V2.8.1 - 2022/02/09
            • V2.8.0 - 2021/12/24
            • V2.7.1 - 2021/11/2
            • V2.7.0 - 2021/10/15
            • V2.6.1 - 2021/09/15
            • V2.5.0 - 2021/05/05
            • V2.4.0 - 2021/04/08
            • V2.3.0 - 2021/03/18
            • V2.2.3 - 2021/02/22
            • V2.2.2 - 2021/02/16
            • V2.2.1 - 2021/02/10
            • V2.2.0 - 2021/02/04
            • V2.1.1 - 2020/11/13
            • V2.1.0 - 2020/09/14
            • V2.0.0 - 2020/07/17
            • V1.0.0 - 2020/06/06
            • V0.2.0 - 2020/05/11
            • V0.1.0 - 2020/03/13
            • V0.0.0 - 2019/11/30
    • yum adapter
      • Features
      • Usage example
        • Module yum
          • Entities
          • Implementations
          • Resources
            • yum.Package
            • yum.PackagesBatch
          • Handlers
            • yum.YumPackage
            • yum.YumPackagesBatch
        • Changelog
          • v2.1.1 - 2025-02-26
          • v2.1.0 - 2024-10-31
          • v2.0.1 - 2024-09-17
          • v2.0.0 - 2024-08-19
          • v1.0.1 - 2024-07-11
          • v1.0.0 - 2024-05-10
          • v0.7.7 - 2023-12-08
          • v0.7.6 - 2023-10-12
          • v0.7.5 - 2023-06-30
          • v0.7.4 - 2023-04-04
          • v0.7.0
          • v0.6.8
          • v0.6.7
          • v0.6.5
          • v0.6.2
          • v0.6.1
          • v0.5.2
• REST API reference
• Compatibility
  • System requirements
  • Module compatibility ranges
• API self-referencing links