grid:member:cloudapi : Member Cloud API object.

Class that represents member Cloud configuration settings.

Object Reference

References to grid:member:cloudapi are object references. The name part of a Member Cloud API object reference has the following components:

  • Name of Member Cloud API object

Example: grid:member:cloudapi/ZGldHdvcmtfdmlldyQxMTk:member1

Restrictions

The object does not support the following operations:

  • Create (insert)

  • Delete

  • Global search (searches via the search object)

  • Scheduling

  • CSV export

Fields

These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.

The basic version of the object contains the field(s): allow_api_admins, allowed_api_admins, enable_service, member, status.

allow_api_admins

allow_api_admins

Defines which administrators are allowed to perform Cloud API request on the Grid Member: no administrators (NONE), any administrators (ALL) or administrators in the ACL list (LIST). Default is ALL.

Type

String.

Valid values are:

  • ALL

  • LIST

  • NONE

Create

The default value is ALL.

Search

The field is not available for search.

Notes

The allow_api_admins is part of the base object.

allowed_api_admins

allowed_api_admins

List of administrators allowed to perform Cloud Platform API requests on that member.

Type

A/An Cloud user struct array.

Create

The default value is:

empty

Search

The field is not available for search.

Notes

The allowed_api_admins is part of the base object.

enable_service

enable_service

Controls whether the Cloud API service runs on the member or not.

Type

Bool.

Create

The default value is undefined.

Search

The field is not available for search.

Notes

The enable_service is part of the base object.

extattrs

extattrs

Extensible attributes associated with the object.

For valid values for extensible attributes, see the following information.

Type

Extensible attributes.

This field allows +/- to be specified as part of the field name when updating the object, see the following information.

Search

For how to search extensible attributes, see the following information.

Notes

The extattrs cannot be updated.

extattrs cannot be written.

gateway_config

gateway_config

Structure containing all the information related to Gateway configuration for the member

Type

A/An Gateway config struct.

Create

The default value is undefined.

Search

The field is not available for search.

member

member

The related Grid Member.

Type

A/An Grid member serving DHCP struct.

Search

The field is not available for search.

Notes

The member is part of the base object.

The member cannot be updated.

member cannot be written.

status

status

Status of Cloud API service on the member.

Type

String.

Valid values are:

  • FAILED

  • INACTIVE

  • UNKNOWN

  • WARNING

  • WORKING

Search

The field is not available for search.

Notes

The status is part of the base object.

The status cannot be updated.

status cannot be written.

Search-only Fields

These fields are used only for searching. They are not actual members of the object and therefore the server does not return these fields with this name unless they are nested return fields.

comment

comment

Comment for the Member Cloud API object; maximum 256 characters.

Type

String.

Search

The field is available for search via

  • ‘~=’ (regular expression)

  • ‘=’ (exact equality)

  • ‘:=’ (case insensitive search)

Notes

comment is a search-only field.

ipv4addr

ipv4addr

The IPv4 Address of the Grid Member.

Type

String.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

ipv4addr is a search-only field.

ipv6addr

ipv6addr

The IPv6 Address of the Grid Member.

Type

String.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

ipv6addr is a search-only field.

name

name

The host name of related Member.

Type

String.

Search

The field is available for search via

  • ‘~=’ (regular expression)

  • ‘=’ (exact equality)

Notes

name is a search-only field.

Fields List

Field

Type

Req

R/O

Base

Search

allow_api_admins

String

N

N

Y

N/A

allowed_api_admins

[struct]

N

N

Y

N/A

enable_service

Bool

N

N

Y

N/A

extattrs

Extattr

N

Y

N

ext

gateway_config

struct

N

N

N

N/A

member

struct

N

Y

Y

N/A

status

String

N

Y

Y

N/A

Search-only Fields List

Field

Type

Search

comment

String

: = ~

ipv4addr

String

=

ipv6addr

String

=

name

String

= ~