Infoblox::Grid::CloudAPI::Tenant - Infoblox::Grid::CloudAPI::Tenant object.

NAME

Infoblox::Grid::CloudAPI::Tenant - Infoblox::Grid::CloudAPI::Tenant object.

DESCRIPTION

This object represents an administrative concept in Cloud Management Platforms that associates all the network elements (networks, zones, VMs, IPs, ...) that are related and constitutive of the tenant.

CONSTRUCTOR

SESSION METHODS

This section describes all the methods in an Infoblox::Session module that you can apply to a Grid member 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.

Key Reference 
 Apply the following attribute to get a specific object:
   comment       - Optional. Descriptive comments.
   id            - Optional. Unique ID associated with the tenant. Set at creation time only.
   name          - Required. Name of the tenant.
   unmanaged     - Optional. Flag to indicate if the tenant is unmanaged. Valid value is 'true' or 'false'.
Example 
 $session->get(object => "Infoblox::Grid::CloudAPI::Tenant", comment => "comment");

Infoblox::Session->modify( )

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

Example 
 $session->modify($tenant_object);

Infoblox::Session->search( )

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

Key Reference 
 Apply the following attribute to get a specific object:
   comment       - Optional. Descriptive comments (regular expression).
   id            - Optional. Unique ID associated with the tenant. Set at creation time only (regular expression).
   name          - Required. Name of the tenant (regular expression).
   unmanaged     - Optional. Flag to indicate if the tenant is unmanaged. Valid value is 'true' or 'false'.
Example 
 $session->get(object => "Infoblox::Grid::CloudAPI::Tenant", comment => "comment");

METHODS

This section describes all the methods that you can use to set or retrieve the attribute values of the object.

comment( )

Use this method to set or retrieve a descriptive comment.

Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.

Parameter

The valid value is a comment in string format (UTF8) with a maximum of 256 bytes.

Returns

If you specified a parameter, the method returns true when the modification succeeds, and returns false when the operation fails.

If you did not specify a parameter, the method returns the attribute value.

Example 
 # Get comment
 $comment = $tenant->comment();
 # Modify comment
 $tenant->comment("New comment");

first_seen( )

Use this method to retrieve the date and time the first time the tenant was seen on the system. This is a read-only attribute.

Parameter

None

Returns

The valid return value is number of seconds that have elapsed since January 1st, 1970 UTC.

Example 
 # Get first_seen
 $first_seen = $tenant->first_seen();

id( )

Use this method to retrieve a unique ID associated with the tenant. Set at creation time only. This is a read-only attribute.

Parameter

None

Returns

The method returns attribute value.

Example 
 # Get id
 $id = $tenant->id();

last_seen( )

Use this method to retrieve the date and time the last time the tenant was seen on the system. This is a read-only attribute.

Parameter

None

Returns

The valid return value is number of seconds that have elapsed since January 1st, 1970 UTC.

Example 
 # Get last_seen
 $last_seen = $tenant->last_seen();

name( )

Use this method to set or retrieve the name of the tenant.

Include the specified parameter to set the attribute value. Omit the parameter to retrieve the attribute value.

Parameter

The valid value is a comment in string format (UTF8) with a maximum of 64 bytes.

Returns

If you specified a parameter, the method returns true when the modification succeeds, and returns false when the operation fails.

If you did not specify a parameter, the method returns the attribute value.

Example 
 # Get name
 $name = $tenant->name();
 # Modify name
 $tenant->name("New name");

network_count( )

Use this method to retrieve the number of networks associated with the tenant. This is a read-only attribute.

Parameter

None

Returns

The method returns attribute value.

Example 
 # Get network_count
 $network_count = $tenant->network_count();

vm_count( )

Use this method to retrieve the number of VMs associated with the tenant. This is a read-only attribute.

Parameter

None

Returns

The method returns attribute value.

Example 
 # Get vm_count
 $vm_count = $tenant->vm_count();

unmanaged( )

Use this method to retrieve the boolean flag used to indicate if the tenant is unmanaged or not. This is a read-only attribute

Parameter

None

Returns

The method returns attribute value. The valid return value is "true" or "false".

Example 
 # Get unmanaged
 $unmanaged = $tenant->unmanaged();

first_discovered_timestamp( )

Use this method to retrieve the date and time the tenant was first seen on the system. This is a read-only attribute.

Parameter

None

Returns

The valid return value is the number of seconds that have elapsed since January 1st, 1970 UTC.

Example 
 # Get first_discovered_timestamp
 $first_discovered_timestamp = $tenant->first_discovered_timestamp();

last_discovered_timestamp( )

Use this method to retrieve the date and time the tenant was last seen on the system. This is a read-only attribute.

Parameter

None

Returns

The valid return value is the number of seconds that have elapsed since January 1st, 1970 UTC.

Example 
 # Get last_discovered_timestamp
 $last_discovered_timestamp = $tenant->last_discovered_timestamp();

AUTHOR

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

SEE ALSO

Infoblox::Session->get(), Infoblox::Session->search(), Infoblox::Session->modify()

COPYRIGHT

Copyright (c) 2017 Infoblox Inc.