Dynamic Provisioning

class DynamicProvisioning(api)

Bases: _ClientWorkBase

create(name, certificate_container, ca_template, contacts, description=None, naming_pattern='$Client.DNSName$', common_name='$Client.DNSName$', organization=None, organizational_unit=None, city_locality=None, state_province=None, country=None, subject_alternative_names='$Client.DNSname$', capi_keystore=False, capi_friendly_name='', capi_trustee='', key_bit_strength=2048, retry_interval=15, log_threshold='Info', attributes=None, get_if_already_exists=True)
Parameters:

  • name (str) – The name of the client work

  • certificate_container (Union[config.Object, str]) – Config Object or Distinguished Name (DN) of the folder to place certificates.

  • ca_template (Union[config.Object, str]) – Config Object or DN of the Certificate Authority.

  • contacts (list[ident.Identity, str]) – List of Identity Object or Prefixed Name of the contacts.

  • description (str) – A description for the certificates

  • naming_pattern (str) – object naming pattern (defaults to: $Client.DNSName$)

  • common_name (str) – Common name for the certificate

  • organization (str) – Organization for the certificate

  • organizational_unit (list[str]) – A list of organizational units for the certificate

  • city_locality (str) – A city or locality for the certificate

  • state_province (str) – A state or province for the certificate

  • country (str) – A country code for the certificate

  • subject_alternative_names (str) – A subject alternative name for the certificate

  • capi_keystore (bool) – Use a capi keystore (defaults to False)

  • capi_friendly_name (str) – Friendly name in the keystore

  • capi_trustee (str) – Set the capi trustee

  • key_bit_strength (int) – Key size for the certificate (defaults to 2048)

  • retry_interval (int) – An interval in minutes (15, 30, 45, 60) for the agent to retry

  • log_threshold (str) – Set the logging level (defaults to INFO)

  • attributes (dict) – Additional attributes to apply to the object.

  • get_if_already_exists (bool) – If the objects already exists, just return it as is.

Returns:

Config Object of the client work.

delete(work)

Deletes the client work.

Parameters:

work (Union[config.Object, str]) – Config Object or name of the client work.

disable(work)

Disables the client work.

Parameters:

work (Union[config.Object, str]) – Config Object or name of the client work.

enable(work)

Enables the client work.

Parameters:

work (Union[config.Object, str]) – Config Object or name of the client work.

get(name, raise_error_if_not_exists=True)
Parameters:

  • name (str) – The name of the client work.

  • raise_error_if_not_exists (bool) – Raise an exception if the client work does not exist.

Returns:

Config Object of the client work.

list()

Lists all client work.

Returns:

List of Config Object of all client work.