ListIpInventoryDetails¶

class oci.core.models.ListIpInventoryDetails(**kwargs)¶

Bases: object

Required input parameters for retrieving IP Inventory data within the specified compartments of a region.

Attributes

`RESOURCE_TYPE_LIST_RESOURCE`	A constant which can be used with the resource_type_list property of a ListIpInventoryDetails.
`SORT_BY_DISPLAYNAME`	A constant which can be used with the sort_by property of a ListIpInventoryDetails.
`SORT_BY_DNS_HOSTNAME`	A constant which can be used with the sort_by property of a ListIpInventoryDetails.
`SORT_BY_REGION`	A constant which can be used with the sort_by property of a ListIpInventoryDetails.
`SORT_BY_UTILIZATION`	A constant which can be used with the sort_by property of a ListIpInventoryDetails.
`SORT_ORDER_ASC`	A constant which can be used with the sort_order property of a ListIpInventoryDetails.
`SORT_ORDER_DESC`	A constant which can be used with the sort_order property of a ListIpInventoryDetails.
`address_type_list`	Gets the address_type_list of this ListIpInventoryDetails.
`compartment_list`	[Required] Gets the compartment_list of this ListIpInventoryDetails.
`overlapping_vcns_only`	Gets the overlapping_vcns_only of this ListIpInventoryDetails.
`override_filters`	Gets the override_filters of this ListIpInventoryDetails.
`pagination_limit`	Gets the pagination_limit of this ListIpInventoryDetails.
`pagination_offset`	Gets the pagination_offset of this ListIpInventoryDetails.
`region_list`	[Required] Gets the region_list of this ListIpInventoryDetails.
`resource_type_list`	Gets the resource_type_list of this ListIpInventoryDetails.
`search_keyword`	Gets the search_keyword of this ListIpInventoryDetails.
`sort_by`	Gets the sort_by of this ListIpInventoryDetails.
`sort_order`	Gets the sort_order of this ListIpInventoryDetails.
`utilization`	Gets the utilization of this ListIpInventoryDetails.

Methods

__init__(**kwargs) Initializes a new ListIpInventoryDetails object with values from keyword arguments.

RESOURCE_TYPE_LIST_RESOURCE = 'Resource'¶: A constant which can be used with the resource_type_list property of a ListIpInventoryDetails. This constant has a value of “Resource”

SORT_BY_DISPLAYNAME = 'DISPLAYNAME'¶: A constant which can be used with the sort_by property of a ListIpInventoryDetails. This constant has a value of “DISPLAYNAME”

SORT_BY_DNS_HOSTNAME = 'DNS_HOSTNAME'¶: A constant which can be used with the sort_by property of a ListIpInventoryDetails. This constant has a value of “DNS_HOSTNAME”

SORT_BY_REGION = 'REGION'¶: A constant which can be used with the sort_by property of a ListIpInventoryDetails. This constant has a value of “REGION”

SORT_BY_UTILIZATION = 'UTILIZATION'¶: A constant which can be used with the sort_by property of a ListIpInventoryDetails. This constant has a value of “UTILIZATION”

SORT_ORDER_ASC = 'ASC'¶: A constant which can be used with the sort_order property of a ListIpInventoryDetails. This constant has a value of “ASC”

SORT_ORDER_DESC = 'DESC'¶: A constant which can be used with the sort_order property of a ListIpInventoryDetails. This constant has a value of “DESC”

__init__(**kwargs)¶

Initializes a new ListIpInventoryDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

region_list (list[str]) – The value to assign to the region_list property of this ListIpInventoryDetails.
compartment_list (list[str]) – The value to assign to the compartment_list property of this ListIpInventoryDetails.
override_filters (bool) – The value to assign to the override_filters property of this ListIpInventoryDetails.
utilization (float) – The value to assign to the utilization property of this ListIpInventoryDetails.
overlapping_vcns_only (bool) – The value to assign to the overlapping_vcns_only property of this ListIpInventoryDetails.
address_type_list (list[oci.core.models.AddressType]) – The value to assign to the address_type_list property of this ListIpInventoryDetails.
resource_type_list (list[str]) – The value to assign to the resource_type_list property of this ListIpInventoryDetails. Allowed values for items in this list are: “Resource”
search_keyword (str) – The value to assign to the search_keyword property of this ListIpInventoryDetails.
sort_by (str) – The value to assign to the sort_by property of this ListIpInventoryDetails. Allowed values for this property are: “DISPLAYNAME”, “UTILIZATION”, “DNS_HOSTNAME”, “REGION”
sort_order (str) – The value to assign to the sort_order property of this ListIpInventoryDetails. Allowed values for this property are: “ASC”, “DESC”
pagination_offset (int) – The value to assign to the pagination_offset property of this ListIpInventoryDetails.
pagination_limit (int) – The value to assign to the pagination_limit property of this ListIpInventoryDetails.

address_type_list¶

Gets the address_type_list of this ListIpInventoryDetails. List of IP address types used.

Returns:	The address_type_list of this ListIpInventoryDetails.
Return type:	list[oci.core.models.AddressType]

compartment_list¶

[Required] Gets the compartment_list of this ListIpInventoryDetails. List the OCID of the compartments.

Returns:	The compartment_list of this ListIpInventoryDetails.
Return type:	list[str]

overlapping_vcns_only¶

Gets the overlapping_vcns_only of this ListIpInventoryDetails. List of overlapping VCNs.

Returns:	The overlapping_vcns_only of this ListIpInventoryDetails.
Return type:	bool

override_filters¶

Gets the override_filters of this ListIpInventoryDetails. List of selected filters.

Returns:	The override_filters of this ListIpInventoryDetails.
Return type:	bool

pagination_limit¶

Gets the pagination_limit of this ListIpInventoryDetails. Specifies the maximum number of results displayed per page for a paginated “List” call. For more information, see List Pagination. Example: 50

Returns:	The pagination_limit of this ListIpInventoryDetails.
Return type:	int

pagination_offset¶

Gets the pagination_offset of this ListIpInventoryDetails. Most List operations paginate results. Results are paginated for the ListInstances operations. When you call a paginated List operation, the response indicates more pages of results by including the opc-next-page header. For more information, see List Pagination.

Returns:	The pagination_offset of this ListIpInventoryDetails.
Return type:	int

region_list¶

[Required] Gets the region_list of this ListIpInventoryDetails. Lists the selected regions.

Returns:	The region_list of this ListIpInventoryDetails.
Return type:	list[str]

resource_type_list¶

Gets the resource_type_list of this ListIpInventoryDetails. List of VCN resource types.

Allowed values for items in this list are: “Resource”

Returns:	The resource_type_list of this ListIpInventoryDetails.
Return type:	list[str]

search_keyword¶

Gets the search_keyword of this ListIpInventoryDetails. Filters the results for the specified string.

Returns:	The search_keyword of this ListIpInventoryDetails.
Return type:	str

sort_by¶

Gets the sort_by of this ListIpInventoryDetails. Provide the sort order (sortOrder) to sort the fields such as TIMECREATED in descending or descending order, and DISPLAYNAME in case sensitive.

Note: For some “List” operations (for example, ListInstances), sort resources by an availability domain when the resources belong to a single availability domain. If you sort the “List” operations without specifying an availability domain, the resources are grouped by availability domains and then sorted.

Allowed values for this property are: “DISPLAYNAME”, “UTILIZATION”, “DNS_HOSTNAME”, “REGION”

Returns:	The sort_by of this ListIpInventoryDetails.
Return type:	str

sort_order¶

Gets the sort_order of this ListIpInventoryDetails. Specifies the sort order to use. Select either ascending (ASC) or descending (DESC) order. The DISPLAYNAME sort order is case sensitive.

Allowed values for this property are: “ASC”, “DESC”

Returns:	The sort_order of this ListIpInventoryDetails.
Return type:	str

utilization¶

Gets the utilization of this ListIpInventoryDetails. The CIDR utilization of a VCN.

Returns:	The utilization of this ListIpInventoryDetails.
Return type:	float