F5 LTM Advanced

class F5LTMAdvanced(api)

Bases: _ApplicationBase

create(name, device, description=None, contacts=None, approvers=None, application_credential=None, https_port=None, ssh_port=None, device_certificate=None, provisioning_mode=None, certificate_and_key_file=None, private_key_credential=None, force_profile_update=None, install_chain=None, bundle_certificate=None, overwrite_chain_file=None, ca_chain_file=None, use_fips=None, overwrite_certificate_and_key=None, delete_previous_cert_and_key=None, provisioning_target=None, config_sync=None, ssl_profile=None, ssl_profile_type=None, parent_ssl_profile=None, ssl_partition=None, sni_server_name=None, sni_default=None, virtual_server=None, virtual_server_partition=None, use_advanced_settings=None, client_certificate_requirement=None, server_certificate_requirement=None, frequency=None, chain_traversal_depth=None, certificate_bundle=None, authentication_name=None, attributes=None, get_if_already_exists=True)

Creates a F5 LTM Advanced application object.

Parameters

  • name (str) – Name of the application object.

  • device (Union[config.Object, str]) – Config Object or Distinguished Name (DN) of the device object.

  • description (str) – Description for the application object.

  • contacts (List[Union[ident.Identity, str]]) – List of Identity Object or Prefixed Name as contacts for the application object.

  • approvers (List[Union[ident.Identity, str]]) – List of Identity Object or Prefixed Name as approvers for the application object.

  • application_credential (Union[config.Object, str]) – Config Object or Distinguished Name (DN) of the application credential.

  • https_port (int) – HTTPS port number.

  • ssh_port (int) – SSH port number.

  • device_certificate (bool) – The certificate is a device certificate.

  • provisioning_mode (int) – Provisioning mode.

  • certificate_and_key_file (str) – Certificate and key file.

  • private_key_credential (Union[config.Object, str]) – Config Object or Distinguished Name (DN) of the private key credential.

  • force_profile_update (bool) – Force profile update.

  • install_chain (bool) – Install the certificate chain.

  • bundle_certificate (bool) – Bundle certificate.

  • overwrite_chain_file (bool) – Overwrite the chain file.

  • ca_chain_file (str) – CA Chain file.

  • use_fips (bool) – Use FIPS.

  • overwrite_certificate_and_key (bool) – Overwrite certificate an key.

  • delete_previous_cert_and_key (bool) – Delete old certificate and key.

  • provisioning_target (str) – Provisioning target for high availability.

  • config_sync (bool) – Config sync.

  • ssl_profile (str) – SSL profile name.

  • ssl_profile_type (str) – SSL profile type.

  • parent_ssl_profile (str) – Parent SSL profile name.

  • ssl_partition (str) – SSL partition.

  • sni_server_name (str) – SNI server name.

  • sni_default (bool) – SNI default.

  • virtual_server (str) – Virtual server name.

  • virtual_server_partition (str) – Virtual server partition.

  • use_advanced_settings (bool) – Must be set if using advanced options.

  • client_certificate_requirement (str) – Require/request/ignore.

  • server_certificate_requirement (str) – Require/ignore.

  • frequency (str) – Once or Always.

  • chain_traversal_depth (int) – Chain traversal depth.

  • certificate_bundle (Union[config.Object, str]) – Config Object or Distinguished Name (DN) of the certificate bundle.

  • authentication_name (str) – Authentication name.

  • attributes (dict) – Additional attributes pertaining to the application object.

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

Returns

Config Object of the application.

delete(application)

Deletes an application object.

Parameters

application (Union[Object, str]) – Config Object or Distinguished Name (DN) of the application object.

disable(application)

Disables all processing and provisioning of the application.

Parameters

application (Union[Object, str]) – Config Object or Distinguished Name (DN) of the application object.

enable(application)

Enables all processing and provisioning of the application.

Parameters

application (Union[Object, str]) – Config Object or Distinguished Name (DN) of the application object.

get(application_dn, raise_error_if_not_exists=True)
Parameters
Returns

Config Object of the application

get_associated_certificate(application)
Parameters

application (Union[Object, str]) – Config Object or Distinguished Name (DN) of the application object.

Returns

Config Object of the certificate object associated to the application object.

get_stage(application)
Parameters

application (Union[Object, str]) – Config Object or Distinguished Name (DN) of the application object.

Returns

The current stage if it exists. Otherwise, returns None.

Return type

int

get_status(application)
Parameters

application (Union[Object, str]) – Config Object or Distinguished Name (DN) of the application object.

Returns

The current processing status of the application object or None if a status does not exist.

Return type

str

wait_for_installation_to_complete(application, timeout=60)

Waits for the application object’s “Last Pushed On” attribute to be a date greater than or equal to the “Last Renewed On” date on the associated certificate. If the certificate has not been recently renewed and is simply being associated to the certificate, either clear the “Last Pushed On” date from the application object or use pytpp.pytpp.features.certificate.Certificate.associate_application() with push_to_new=True.

Parameters