Management::KeyCertificate::key_certificate_import_from_pem

Introduced : BIGIP_v11.5.0
Note: This method is intended for internal F5 use (hence, no guarantees are made about its operation or existence). Please use key_import_from_pem and certificate_import_from_pem for importing keys and certificates. Imports/installs the specified keys and certificates from the given PEM-formatted data.

Prototype

 key_certificate_import_from_pem(
    in ManagementModeType mode,
    in String [] ids,
    in String [] key_pem_data,
    in SecurityType security,
    in String [] passwords,
    in String [] certificate_pem_data,
    in boolean overwrite
);

Parameters

Parameter Type Description
mode ManagementModeType The key/cert management mode.
ids String [] The string identifications of the keys/certificates to import/install.
key_pem_data String [] The PEM-formatted data associated with the specified keys.
security SecurityType The security type of the installed key.
passwords String [] The passwords of keys, if they are encrypted.
certificate_pem_data String [] The PEM-formatted data associated with the specified certificates.
overwrite boolean The boolean indicating whether we should overwrite the key files on disk if they existed. If this parameter is false, and the files already exist, then a “Would overwrite” exception will be generated.

Return Type

Type Description
void  

Exceptions

Exception Description
Common::AccessDenied Raised if the client credentials are not valid.
Common::InvalidArgument Raised if one of the arguments is invalid.
Common::OperationFailed Raised if an operation error occurs.

See Also

Warning

The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.

Sample Code


The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.