upsertInternalCACertificate

The upsertInternalCACertificate operation handles configuration related to InternalCACertificate model. 

Description

This API call is not allowed on the standby unit in an HA pair.

Data Parameters

Parameter Required Type Description
version False string A unique string version assigned by the system when the object is created or modified. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete an existing object. As the version will change every time the object is modified, the value provided in this identifier must match exactly what is present in the system or the request will be rejected.
name True string A mandatory UTF string containing the name for the certificate. The string can be up to 128 characters. The name is used in the configuration as an object name only, it is not part of the certificate itself.
cert False string PEM formatted X.509v3 certificate.
privateKey False string PEM formatted private key. Only unencrypted keys are supported.
passPhrase False string Password used for encrypted private key. Encrypted keys are not supported yet.
issuerCommonName False string Common Name, typically product name/brand, of the Authority (issuer) that signed and issued the certificate. This is automatically extracted from the uploaded certificate.
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
issuerCountry False string An ISO3166 two character country code of the Authority (issuer) that signed and issued the certificate. This is automatically extracted from the uploaded certificate.
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
issuerLocality False string Locality, city name, of the Authority (issuer) that signed and issued the certificate. This is automatically extracted from the uploaded certificate.
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
issuerOrganization False string Organization, company name, of the Authority (issuer) that signed and issued the certificate. This is automatically extracted from the uploaded certificate.
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
issuerOrganizationUnit False string The Organization Unit, division or unit, of the Authority (issuer) that signed and issued the certificate. This is automatically extracted from the uploaded certificate.
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
issuerState False string State or the province of the Authority (issuer) that signed and issued the certificate. This is automatically extracted from the uploaded certificate.
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
subjectCommonName False string An Unicode alphanumeric string containing the Common Name, typically product name/brand, of the entity (subject) being certified or authenticated in the given certificate. This is mandatory input value for Self-Signed certificate and extracted from an uploaded certificate.
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
subjectCountry False string An ISO3166 two character country code of the Authority (issuer) that signed and issued the certificate. This is mandatory input value for Self-Signed certificate and extracted from an uploaded certificate.
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
subjectDistinguishedName False string A DN (Distinguished Name) defining the entity (subject) being certified or authenticated in the given certificate. For a root certificate the issuer and subject will be the same DN. This is automatically extracted from the uploaded certificate.
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
subjectLocality False string An Unicode alphanumeric string containing the locality, city name, of the entity (subject) being certified or authenticated in the given certificate. This is mandatory input value for Self-Signed certificate and extracted from an uploaded certificate.
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
subjectOrganization False string An Unicode alphanumeric string containing the organization, company name, of the entity (subject) being certified or authenticated in the given certificate. This is mandatory input value for Self-Signed certificate and extracted from an uploaded certificate.
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
subjectOrganizationUnit False string An Unicode alphanumeric string containing the Organization Unit, division or unit, of the entity (subject) being certified or authenticated in the given certificate. This is mandatory input value for Self-Signed certificate and extracted from an uploaded certificate.
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
subjectState False string An Unicode alphanumeric string containing the state or the province of the entity (subject) being certified or authenticated in the given certificate. This is mandatory input value for Self-Signed certificate and extracted from an uploaded certificate.
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
validityStartDate False string This is current date in UTC format for Self-Signed certificate.
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
validityEndDate False string This is set to five years in UTC format from the current date for Self-Signed certificate.
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
isSystemDefined False boolean A boolean value, TRUE and FALSE (the default). The TRUE value indicates that certificate is created by system and cannot be deleted. FALSE indicates that the certificate can be deleted.
certType False string An mandatory enum value that specifies the type of internal certificate. Values can be one of the following.
UPLOAD - Certificate is already defined and certificate and private string will be uploaded.
SELFSIGNED - Generate an internal certificate using the provided values.
id False string A unique string identifier assigned by the system when the object is created. No assumption can be made on the format or content of this identifier. The identifier must be provided whenever attempting to modify/delete (or reference) an existing object.
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
type True string A UTF8 string, all letters lower-case, that represents the class-type. This corresponds to the class name.

Query Parameters

Parameter Required Type Description
filter False string The criteria used to filter the models you are requesting. It should have the following format: {field}{operator}{value}[;{field}{operator}{value}]. Supported operators are: "!"(not equals), ":"(equals), "~"(similar). Supported fields are: "name". Default filtering for Upsert operation is done by name.

Example

- name: Execute 'upsertInternalCACertificate' operation
  ftd_configuration:
    operation: "upsertInternalCACertificate"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        cert: "{{ cert }}"
        privateKey: "{{ private_key }}"
        passPhrase: "{{ pass_phrase }}"
        issuerCommonName: "{{ issuer_common_name }}"
        issuerCountry: "{{ issuer_country }}"
        issuerLocality: "{{ issuer_locality }}"
        issuerOrganization: "{{ issuer_organization }}"
        issuerOrganizationUnit: "{{ issuer_organization_unit }}"
        issuerState: "{{ issuer_state }}"
        subjectCommonName: "{{ subject_common_name }}"
        subjectCountry: "{{ subject_country }}"
        subjectDistinguishedName: "{{ subject_distinguished_name }}"
        subjectLocality: "{{ subject_locality }}"
        subjectOrganization: "{{ subject_organization }}"
        subjectOrganizationUnit: "{{ subject_organization_unit }}"
        subjectState: "{{ subject_state }}"
        validityStartDate: "{{ validity_start_date }}"
        validityEndDate: "{{ validity_end_date }}"
        isSystemDefined: "{{ is_system_defined }}"
        certType: "{{ cert_type }}"
        id: "{{ id }}"
        type: "{{ type }}"
    query_params:
        filter: "{{ filter }}"