REST Resource: projects.locations.customRanges

Resource: CustomRange

A CustomRange represents a user-defined IP address range.

JSON representation 
{
  "name": string,
  "realm": string,
  "parentRange": string,
  "registryBook": string,
  "attributes": [
    {
      object (Attribute)
    }
  ],
  "description": string,
  "labels": {
    string: string,
    ...
  },

  // Union field ip_cidr_range can be only one of the following:
  "ipv4CidrRange": string,
  "ipv6CidrRange": string
  // End of list of possible types for union field ip_cidr_range.
}
Fields
name

string

Required. Identifier. The resource name of the CustomRange, in the format projects/{project}/locations/{location}/customRanges/{customRange}.
realm

string

Optional. The resource name of the Realm associated with the CustomRange, in the format projects/{project}/locations/{location}/realms/{realm}. The Realm must be in the same project as the CustomRange. This field must not be set if the parentRange field is set, as the Realm will be inherited from the parent CustomRange.
parentRange

string

Optional. The resource name of the parent CustomRange, in the format projects/{project}/locations/{location}/customRanges/{customRange}. If specified, the parent CustomRange must be in the same RegistryBook. This field is mutually exclusive with the realm field, as the Realm is inherited from the parent CustomRange.
registryBook

string

Output only. The RegistryBook of the CustomRange. This field is inherited from the Realm or parent CustomRange depending on which one is specified.
attributes[]

object (Attribute)

Optional. The attributes of the CustomRange.
description

string

Optional. The description of the CustomRange.
labels

map (key: string, value: string)

Optional. User-defined labels.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
Union field ip_cidr_range. The IP CIDR range of the CustomRange. ip_cidr_range can be only one of the following:
ipv4CidrRange

string

Optional. The IPv4 CIDR range of the CustomRange.
ipv6CidrRange

string

Optional. The IPv6 CIDR range of the CustomRange.

Methods

create

 Creates a new CustomRange in a given project and location.

delete

 Deletes a single CustomRange.

findFreeIpRanges

 Finds free IP ranges in a single CustomRange.

get

 Gets details of a single CustomRange.

list

 Lists CustomRanges in a given project and location.

patch

 Updates the parameters of a single CustomRange.

showUtilization

 Gets the details of a single CustomRange and its utilization.