Public APIs

It is recommended that you start with juju.model or juju.controller.

• juju.action
  • Action
    • Action.fetch_output()
    • Action.status
    • Action.wait()
• juju.annotation
  • Annotation
• juju.application
  • Application
    • Application.add_relation()
    • Application.add_unit()
    • Application.add_units()
    • Application.attach_resource()
    • Application.charm_name
    • Application.charm_url
    • Application.constraints
    • Application.destroy()
    • Application.destroy_relation()
    • Application.destroy_unit()
    • Application.destroy_units()
    • Application.expose()
    • Application.exposed
    • Application.get_actions()
    • Application.get_annotations()
    • Application.get_config()
    • Application.get_constraints()
    • Application.get_metrics()
    • Application.get_resources()
    • Application.get_series()
    • Application.get_status()
    • Application.get_trusted()
    • Application.life
    • Application.local_refresh()
    • Application.min_units
    • Application.name
    • Application.on_unit_add()
    • Application.on_unit_remove()
    • Application.owner_tag
    • Application.refresh()
    • Application.relate()
    • Application.related_applications()
    • Application.relations
    • Application.remove()
    • Application.remove_relation()
    • Application.reset_config()
    • Application.run()
    • Application.scale()
    • Application.set_annotations()
    • Application.set_config()
    • Application.set_constraints()
    • Application.set_trusted()
    • Application.status
    • Application.status_message
    • Application.subordinate
    • Application.subordinate_units
    • Application.supports_granular_expose_parameters()
    • Application.tag
    • Application.unexpose()
    • Application.units
    • Application.upgrade_charm()
    • Application.workload_version
  • ExposedEndpoint
    • ExposedEndpoint.from_dict()
    • ExposedEndpoint.includes_non_wildcard_cidrs()
    • ExposedEndpoint.includes_spaces()
    • ExposedEndpoint.to_dict()
• juju.constraints
  • ConstraintsDict
    • ConstraintsDict.allocate_public_ip
    • ConstraintsDict.arch
    • ConstraintsDict.container
    • ConstraintsDict.cores
    • ConstraintsDict.cpu_cores
    • ConstraintsDict.cpu_power
    • ConstraintsDict.instance_role
    • ConstraintsDict.instance_type
    • ConstraintsDict.mem
    • ConstraintsDict.root_disk
    • ConstraintsDict.root_dist_source
    • ConstraintsDict.spaces
    • ConstraintsDict.tags
    • ConstraintsDict.virt_type
    • ConstraintsDict.zones
  • DeviceConstraintDict
    • DeviceConstraintDict.attributes
    • DeviceConstraintDict.count
    • DeviceConstraintDict.type
  • StorageConstraintDict
    • StorageConstraintDict.count
    • StorageConstraintDict.pool
    • StorageConstraintDict.size
  • normalize_key()
  • normalize_list_value()
  • normalize_value()
  • parse()
  • parse_device_constraint()
  • parse_storage_constraint()
  • parse_storage_constraints()
• juju.controller
  • ConnectedController
  • Controller
    • Controller.add_cloud()
    • Controller.add_credential()
    • Controller.add_model()
    • Controller.add_secret_backends()
    • Controller.add_user()
    • Controller.api_endpoints
    • Controller.change_user_password()
    • Controller.cloud()
    • Controller.clouds()
    • Controller.connect()
    • Controller.connect_controller()
    • Controller.connect_current()
    • Controller.connection()
    • Controller.controller_name
    • Controller.controller_uuid
    • Controller.create_offer()
    • Controller.destroy()
    • Controller.destroy_model()
    • Controller.destroy_models()
    • Controller.disable_user()
    • Controller.disconnect()
    • Controller.enable_user()
    • Controller.get_cloud()
    • Controller.get_consume_details()
    • Controller.get_current_user()
    • Controller.get_current_username()
    • Controller.get_model()
    • Controller.get_model_info()
    • Controller.get_models()
    • Controller.get_user()
    • Controller.get_users()
    • Controller.grant()
    • Controller.grant_model()
    • Controller.info()
    • Controller.is_connected()
    • Controller.list_models()
    • Controller.list_offers()
    • Controller.list_secret_backends()
    • Controller.model_uuids()
    • Controller.remove_cloud()
    • Controller.remove_offer()
    • Controller.remove_secret_backends()
    • Controller.remove_user()
    • Controller.reset_user_password()
    • Controller.revoke()
    • Controller.revoke_model()
    • Controller.update_endpoints()
    • Controller.update_secret_backends()
    • Controller.watch_model_summaries()
  • RemoveError
• juju.delta
  • ActionDelta
    • ActionDelta.get_entity_class()
  • AnnotationDelta
    • AnnotationDelta.get_entity_class()
    • AnnotationDelta.get_id()
  • ApplicationDelta
    • ApplicationDelta.get_entity_class()
    • ApplicationDelta.get_id()
  • ApplicationOfferDelta
    • ApplicationOfferDelta.get_entity_class()
    • ApplicationOfferDelta.get_id()
  • CharmDelta
    • CharmDelta.get_entity_class()
    • CharmDelta.get_id()
  • EntityDelta
    • EntityDelta.data
    • EntityDelta.get_entity_class()
    • EntityDelta.get_id()
  • MachineDelta
    • MachineDelta.get_entity_class()
  • ModelDelta
    • ModelDelta.get_entity_class()
    • ModelDelta.get_id()
  • RelationDelta
    • RelationDelta.get_entity_class()
  • RemoteApplicationDelta
    • RemoteApplicationDelta.get_entity_class()
    • RemoteApplicationDelta.get_id()
  • UnitDelta
    • UnitDelta.get_entity_class()
    • UnitDelta.get_id()
  • get_entity_class()
  • get_entity_delta()
• juju.errors
  • AbstractMethodError
  • JujuAPIError
  • JujuAgentError
  • JujuAppError
  • JujuApplicationConfigError
  • JujuAuthError
  • JujuBackupError
  • JujuConfigError
  • JujuConnectionError
  • JujuControllerNotFoundError
  • JujuEntityNotFoundError
  • JujuError
  • JujuMachineError
  • JujuModelConfigError
  • JujuModelError
  • JujuNotSupportedError
  • JujuNotValid
  • JujuPermissionError
  • JujuRedirectException
    • JujuRedirectException.ca_cert
    • JujuRedirectException.endpoints
  • JujuUnitError
  • JujuUnknownVersion
  • PylibjujuError
  • PylibjujuProgrammingError
• juju.exceptions
  • DeadEntityException
• juju.juju
  • Juju
    • Juju.get_controller()
    • Juju.get_controllers()
• juju.machine
  • Machine
    • Machine.addresses
    • Machine.agent_status
    • Machine.agent_status_since
    • Machine.agent_version
    • Machine.destroy()
    • Machine.dns_name
    • Machine.get_annotations()
    • Machine.hostname
    • Machine.remove()
    • Machine.scp_from()
    • Machine.scp_to()
    • Machine.series
    • Machine.set_annotations()
    • Machine.ssh()
    • Machine.status
    • Machine.status_message
    • Machine.status_since
    • Machine.tag
• juju.model
  • CharmArchiveGenerator
    • CharmArchiveGenerator.make_archive()
  • CharmhubDeployType
    • CharmhubDeployType.resolve()
  • DeployTypeResult
  • LocalDeployType
    • LocalDeployType.resolve()
  • Model
    • Model.add_local_charm()
    • Model.add_local_charm_dir()
    • Model.add_local_resources()
    • Model.add_machine()
    • Model.add_observer()
    • Model.add_relation()
    • Model.add_secret()
    • Model.add_space()
    • Model.add_ssh_key()
    • Model.add_ssh_keys()
    • Model.all_units_idle()
    • Model.application_offers
    • Model.applications
    • Model.block_until()
    • Model.charmhub
    • Model.connect()
    • Model.connect_current()
    • Model.connect_model()
    • Model.connect_to()
    • Model.connection()
    • Model.connector
    • Model.consume()
    • Model.create_backup()
    • Model.create_offer()
    • Model.create_storage_pool()
    • Model.debug_log()
    • Model.deploy()
    • Model.destroy_unit()
    • Model.destroy_units()
    • Model.disconnect()
    • Model.download_backup()
    • Model.export_bundle()
    • Model.get_action_output()
    • Model.get_action_status()
    • Model.get_annotations()
    • Model.get_backups()
    • Model.get_config()
    • Model.get_constraints()
    • Model.get_controller()
    • Model.get_machines()
    • Model.get_metrics()
    • Model.get_spaces()
    • Model.get_ssh_key()
    • Model.get_ssh_keys()
    • Model.get_status()
    • Model.grant_secret()
    • Model.info
    • Model.integrate()
    • Model.is_connected()
    • Model.list_offers()
    • Model.list_secrets()
    • Model.list_storage()
    • Model.list_storage_pools()
    • Model.machines
    • Model.name
    • Model.new_wait_for_idle()
    • Model.relate()
    • Model.relations
    • Model.remote_applications
    • Model.remove_application()
    • Model.remove_backup()
    • Model.remove_backups()
    • Model.remove_offer()
    • Model.remove_saas()
    • Model.remove_secret()
    • Model.remove_ssh_key()
    • Model.remove_ssh_keys()
    • Model.remove_storage()
    • Model.remove_storage_pool()
    • Model.reset()
    • Model.restore_backup()
    • Model.revoke_secret()
    • Model.set_annotations()
    • Model.set_config()
    • Model.set_constraints()
    • Model.show_storage_details()
    • Model.state
    • Model.strict_mode
    • Model.subordinate_units
    • Model.tag
    • Model.units
    • Model.update_secret()
    • Model.update_storage_pool()
    • Model.wait_for_action()
    • Model.wait_for_idle()
  • ModelEntity
    • ModelEntity.alive
    • ModelEntity.connected
    • ModelEntity.connection
    • ModelEntity.current
    • ModelEntity.data
    • ModelEntity.dead
    • ModelEntity.entity_id
    • ModelEntity.entity_type
    • ModelEntity.latest()
    • ModelEntity.model
    • ModelEntity.next()
    • ModelEntity.on_change()
    • ModelEntity.on_remove()
    • ModelEntity.previous()
    • ModelEntity.safe_data
  • ModelInfo
    • ModelInfo.tag
    • ModelInfo.type_name_override()
  • ModelObserver
    • ModelObserver.on_change()
  • ModelState
    • ModelState.application_offers
    • ModelState.applications
    • ModelState.apply_delta()
    • ModelState.entity_data()
    • ModelState.entity_history()
    • ModelState.get_entity()
    • ModelState.machines
    • ModelState.relations
    • ModelState.remote_applications
    • ModelState.subordinate_units
    • ModelState.units
  • use_new_wait_for_idle()
• juju.placement
  • parse()
• juju.relation
  • Endpoint
    • Endpoint.application
    • Endpoint.application_name
    • Endpoint.interface
    • Endpoint.name
    • Endpoint.role
    • Endpoint.scope
  • Relation
    • Relation.applications
    • Relation.endpoints
    • Relation.is_peer
    • Relation.is_subordinate
    • Relation.matches()
    • Relation.peers
    • Relation.provides
    • Relation.requires
• juju.tag
  • action()
  • application()
  • cloud()
  • controller()
  • credential()
  • machine()
  • model()
  • space()
  • storage()
  • unit()
  • untag()
  • user()
• juju.unit
  • Unit
    • Unit.add_storage()
    • Unit.agent_status
    • Unit.agent_status_message
    • Unit.agent_status_since
    • Unit.attach_storage()
    • Unit.destroy()
    • Unit.detach_storage()
    • Unit.get_annotations()
    • Unit.get_metrics()
    • Unit.get_public_address()
    • Unit.get_subordinates()
    • Unit.is_leader_from_status()
    • Unit.is_subordinate
    • Unit.machine
    • Unit.name
    • Unit.principal_unit
    • Unit.public_address
    • Unit.remove()
    • Unit.resolved()
    • Unit.run()
    • Unit.run_action()
    • Unit.scp_from()
    • Unit.scp_to()
    • Unit.set_annotations()
    • Unit.ssh()
    • Unit.tag
    • Unit.workload_status
    • Unit.workload_status_message
    • Unit.workload_status_since
• juju.user
  • User
    • User.access
    • User.created_by
    • User.date_created
    • User.disable()
    • User.disabled
    • User.display_name
    • User.enable()
    • User.enabled
    • User.grant()
    • User.grant_or_revoke()
    • User.last_connection
    • User.modify_controller_access()
    • User.modify_model_access()
    • User.modify_offer_access()
    • User.revoke()
    • User.secret_key
    • User.set_password()
    • User.tag
    • User.username
• juju.utils
  • Addrs
    • Addrs.componentType
  • IdQueue
    • IdQueue.get()
    • IdQueue.put()
    • IdQueue.put_all()
  • RegistrationInfo
  • base_channel_from_series()
  • base_channel_to_series()
  • block_until()
  • block_until_with_coroutine()
  • execute_process()
  • generate_user_controller_access_token()
  • get_base_from_origin_or_channel()
  • get_local_charm_base()
  • get_local_charm_charmcraft_yaml()
  • get_local_charm_data()
  • get_local_charm_manifest()
  • get_local_charm_metadata()
  • get_os_from_series()
  • get_series_version()
  • get_version_series()
  • juju_config_dir()
  • juju_ssh_key_paths()
  • parse_base_arg()
  • read_ssh_key()
  • run_with_interrupt()
  • series_for_charm()
  • series_selector()
  • should_upgrade_resource()
  • user_requested()
  • wait_for_bundle()

Python Library for Juju.