Management::KeyCertificate::get_certificate_list

Introduced : BIG-IP_v9.0
Gets the list of all installed certificates and their information. If there&aposs a certificate bundle, only the first certificate in the bundle is returned, and and is_bundle flag will be set to true for the correponding bundle file name.

Prototype

CertificateInformation [] get_certificate_list(
    in ManagementModeType mode
);

Parameters

Parameter Type Description
mode ManagementModeType The key/cert management mode.

Return Type

Type Description
CertificateInformation [] The list of certificates and their information.

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

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:key="urn:iControl:Management/KeyCertificate">
   <soapenv:Header/>
   <soapenv:Body>
      <key:get_certificate_list soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <mode xsi:type="urn:Management.KeyCertificate.ManagementModeType" xmlns:urn="urn:iControl">MANAGEMENT_MODE_DEFAULT</mode>
      </key:get_certificate_list>
   </soapenv:Body>
</soapenv:Envelope>

Above XML code for a request will retrieve Certificates used in Profiles.

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.