SSLKeyAndCertificate
Advanced load balancer SSLKeyAndCertificate object
Name | Description | Type | Notes |
---|---|---|---|
_create_time | Timestamp of resource creation | EpochMsTimestamp | Readonly Sortable |
_create_user | ID of the user who created this resource | string | Readonly |
_last_modified_time | Timestamp of last modification | EpochMsTimestamp | Readonly Sortable |
_last_modified_user | ID of the user who last modified this resource | string | Readonly |
_links | References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST. |
array of ResourceLink | Readonly |
_protection | Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. |
string | Readonly |
_revision | Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. |
int | |
_schema | Schema for this resource | string | Readonly |
_self | Link to this resource | SelfResourceLink | Readonly |
_system_owned | Indicates system owned resource | boolean | Readonly |
ca_certs | Ca certs CA certificates in certificate chain. |
array of ALBCertificateAuthority | |
certificate | Certificate Placeholder for description of property certificate of obj type SSLKeyAndCertificate field type str type ref. |
ALBSSLCertificate | Required |
certificate_base64 | Certificate base64 States if the certificate is base64 encoded. Default value when not specified in API or module is interpreted by ALB Controller as false. |
boolean | Default: "False" |
children | subtree for this type within policy tree subtree for this type within policy tree containing nested elements. |
array of ChildPolicyConfigResource Children are not allowed for this type |
|
created_by | Created by Creator name. |
string | |
description | Description of this resource | string | Maximum length: 1024 Sortable |
display_name | Identifier to use when displaying entity in logs or GUI Defaults to ID if not set |
string | Maximum length: 255 Sortable |
dynamic_params | Dynamic params Dynamic parameters needed for certificate management profile. |
array of ALBCustomParams | |
enable_ocsp_stapling | Enable ocsp stapling Enables OCSP Stapling. Default value when not specified in API or module is interpreted by ALB Controller as false. |
boolean | Default: "False" |
enckey_base64 | Enckey base64 Encrypted private key corresponding to the private key (e.g. those generated by an HSM such as Thales nShield). |
string | |
enckey_name | Enckey name Name of the encrypted private key (e.g. those generated by an HSM such as Thales nShield). |
string | |
format | Format Format of the Key/Certificate file. Enum options - SSL_PEM, SSL_PKCS12. Default value when not specified in API or module is interpreted by ALB Controller as SSL_PEM. |
ALBSSLFormat | Default: "SSL_PEM" |
hardwaresecuritymodulegroup_path | Hardwaresecuritymodulegroup path It is a reference to an object of type HardwareSecurityModuleGroup. |
string | |
id | Unique identifier of this resource | string | Sortable |
key | Key Private key. |
string | |
key_base64 | Key base64 States if the private key is base64 encoded. Default value when not specified in API or module is interpreted by ALB Controller as false. |
boolean | Default: "False" |
key_params | Key params Placeholder for description of property key_params of obj type SSLKeyAndCertificate field type str type ref. |
ALBSSLKeyParams | |
key_passphrase | Key passphrase Passphrase used to encrypt the private key. |
string | |
marked_for_delete | Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. |
boolean | Readonly Default: "False" |
ocsp_config | Ocsp config Configuration related to OCSP. |
ALBOCSPConfig | |
overridden | Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties. |
boolean | Readonly Default: "False" |
parent_path | Path of its parent Path of its parent |
string | Readonly |
path | Absolute path of this object Absolute path of this object |
string | Readonly |
relative_path | Relative path of this object Path relative from its parent |
string | Readonly |
resource_type | Must be set to the value ALBSSLKeyAndCertificate | string | |
status | Status Enum options - SSL_CERTIFICATE_FINISHED, SSL_CERTIFICATE_PENDING. Default value when not specified in API or module is interpreted by ALB Controller as SSL_CERTIFICATE_FINISHED. |
ALBSSLCertificateStatus | Default: "SSL_CERTIFICATE_FINISHED" |
tags | Opaque identifiers meaningful to the API user | array of Tag | Maximum items: 30 |
type | Type Enum options - SSL_CERTIFICATE_TYPE_VIRTUALSERVICE, SSL_CERTIFICATE_TYPE_SYSTEM, SSL_CERTIFICATE_TYPE_CA. |
ALBSSLCertificateType | |
unique_id | A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites. |
string | Readonly |