PolicyIgmpProfile (schema)

IGMP Profile

IGMP profile.
Name Description Type Notes
_create_time Timestamp of resource creation EpochMsTimestamp Readonly
_create_user ID of the user who created this resource string Readonly
_last_modified_time Timestamp of last modification EpochMsTimestamp Readonly
_last_modified_user ID of the user who last modified this resource string Readonly
_links References related to this resource

The server will populate this field when returing the resource. Ignored on PUT and POST.
array of ResourceLink Readonly
_protection Indicates protection status of this resource

Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
string Readonly
_revision Generation of this resource config

The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.
_schema Schema for this resource string Readonly
_self Link to this resource SelfResourceLink Readonly
_system_owned Indicates system owned resource boolean Readonly
children subtree for this type within policy tree

subtree for this type within policy tree containing nested elements.
array of ChildPolicyConfigResource
Children are not allowed for this type
description Description of this resource string Maximum length: 1024
display_name Identifier to use when displaying entity in logs or GUI

Defaults to ID if not set
string Maximum length: 255
id Unique identifier of this resource string Sortable
last_member_query_interval Max Response Time

Max Response Time inserted into Group-Specific Queries sent in response to Leave Group messages,
and is also the amount of time between Group-Specific Query messages. This value may be tuned to
modify the "leave latency" of the network.
A reduced value results in reduced time to detect the loss of the last member of a group.
int Minimum: 1
Maximum: 25
Default: "1"
marked_for_delete Indicates whether the intent object is marked for deletion

Intent objects are not directly deleted from the system when a delete
is invoked on them. They are marked for deletion and only when all the
realized entities for that intent object gets deleted, the intent object
is deleted. Objects that are marked for deletion are not returned in
GET call. One can use the search API to get these objects.
boolean Readonly
Default: "False"
overridden Indicates whether this object is the overridden intent object

Global intent objects cannot be modified by the user.
However, certain global intent objects can be overridden locally by use
of this property. In such cases, the overridden local values take
precedence over the globally defined values for the properties.
boolean Readonly
Default: "False"
parent_path Path of its parent

Path of its parent
string Readonly
path Absolute path of this object

Absolute path of this object
string Readonly
query_interval Interval between general IGMP host-query messages

Interval(seconds) between general IGMP host-query messages.
int Minimum: 1
Maximum: 1800
Default: "30"
query_max_response_time The maximum elapsed time between response

The query response interval(seconds) is the maximum amount of time that can elapse between
when the querier router sends a host-query message and when it receives a response
from a host. Configuring this interval allows admins to adjust the burstiness of
IGMP messages on the subnet; larger values make the traffic less bursty, as host
responses are spread out over a larger interval.

The number of seconds represented by the query_max_response_time must be less than the query_interval.
int Minimum: 1
Maximum: 25
Default: "10"
relative_path Relative path of this object

Path relative from its parent
string Readonly
resource_type Must be set to the value PolicyIgmpProfile string
robustness_variable The Robustness Variable

The Robustness Variable allows tuning for the expected packet loss on a subnet.
If a subnet is expected to be lossy, the Robustness Variable may be increased.
IGMP is robust to (Robustness Variable-1) packet losses.
The Robustness Variable must not be zero, and SHOULD NOT be one.
int Minimum: 1
Maximum: 255
Default: "2"
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30
unique_id A unique identifier assigned by the system

This is a UUID generated by the GM/LM to uniquely identify
entites in a federated environment. For entities that are
stretched across multiple sites, the same ID will be used
on all the stretched sites.
string Readonly