Infoblox::Grid::CACertificate - CA certificate description.


NAME

Infoblox::Grid::CACertificate - CA certificate description.


DESCRIPTION

An Infoblox::Grid::CACertificate object represents a CA certificate description.


SESSION METHODS

This section describes all the methods in an Infoblox::Session module that you can apply to an Infoblox::Grid::CACertificate object.

Infoblox::Session->get( )

Use this method to retrieve all the matching objects from the Infoblox appliance. See Infoblox::Session->get() for parameters and return values.

Example
 my @retrieved_objs = $session->get(
      object => 'Infoblox::Grid::CACertificate',
      serial => 'serial',
 );
 my @retrieved_objs = $session->get(
      object  => 'Infoblox::Grid::CACertificate',
      issuer => 'issuer',
 );
 my @retrieved_objs = $session->get(
      object   => 'Infoblox::Grid::CACertificate',
      distinguished_name => 'distinguished_name',
 );

Infoblox::Session->remove( )

Use this method to remove an object from the Infoblox appliance. See Infoblox::Session->remove() for parameters and return values.

To remove a specific object, first use get() to retrieve the object, and then submit it for removal.

Example
 #Get the objects with the specified serial.
 my @retrieved_objs = $session->get(
      object => 'Infoblox::Grid::CACertificate',
      serial => 'serial',
 );
 #Find the desired object on the retrieved list.
 my $desired_ca_cert = $retrieved_objs[0];
 # Submit for removal
 my $response = $session->remove($desired_ca_cert);

Infoblox::Session->search( )

Use this method to retrieve all the matching objects from the Infoblox appliance. See Infoblox::Session->search() for parameters and return values.

Example
 my @retrieved_objs = $session->search(
      object => 'Infoblox::Grid::CACertificate',
      serial => 'serial',
 );
 my @retrieved_objs = $session->search(
      object  => 'Infoblox::Grid::CACertificate',
      issuer => 'issuer',
 );
 my @retrieved_objs = $session->search(
      object   => 'Infoblox::Grid::CACertificate',
      distinguished_name => 'distinguished_name',
 );


METHODS

This section describes all the methods that you can use to configure and retrieve the attribute values of an Infoblox::Grid::CACertificate object.

distinguished_name( )

Use this method to retrieve certificate subject name. This attribute is read-only and cannot be set.

Parameter

None.

Returns

The method returns the attribute value.

Example
 #Get distinguished_name
 my $distinguished_name = $ca_cert->distinguished_name();

issuer( )

Use this method to retrieve issuer subject name. This attribute is read-only and cannot be set.

Parameter

None.

Returns

The method returns the attribute value.

Example
 #Get issuer
 my $issuer = $ca_cert->issuer();

serial( )

Use this method to retrieve Certificate serial number in hex format. This attribute is read-only and cannot be set.

Parameter

None.

Returns

The method returns the attribute value.

Example
 #Get serial
 my $serial = $ca_cert->serial();

used_by( )

Use this method to retrieve information about usages of the certificate. This attribute is read-only and cannot be set.

Parameter

None.

Returns

The method returns the attribute value. If the returned value is equal to SSL/TLS - all certificates in CA store can be used for HTTPS and if the returned value is equal to CAS - additionally certificate can be assigned to Certificate Authentication Group.

Example
 #Get used_by
 my $used_by = $ca_cert->used_by();


AUTHOR

Infoblox Inc. http://www.infoblox.com/


COPYRIGHT

Copyright (c) 2017 Infoblox Inc.