| _create_time |
Timestamp of resource creation |
EpochMsTimestamp |
Readonly
Sortable |
| _create_user |
ID of the user who created this resource |
string |
Readonly |
| _last_modified_time |
Timestamp of last modification |
EpochMsTimestamp |
Readonly
Sortable |
| _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
entity.
|
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. |
int |
|
| _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 |
|
| days |
Days of the week
Days of week on which rules will be enforced. If property is omitted,
then days of the week will not considered while calculating the
firewall schedule. It should not be present when the recurring flag
is false.
|
array of PolicyFirewallSchedulerDays |
|
| description |
Description of this resource |
string |
Maximum length: 1024
Sortable |
| display_name |
Identifier to use when displaying entity in logs or GUI
Defaults to ID if not set |
string |
Maximum length: 255
Sortable |
| end_date |
End date in MM/DD/YYYY
End date on which schedule to end. Example, 12/22/2019.
|
string |
Required |
| end_time |
End time
If recurring field is set false, then this field must be present. The
schedule will be enforced till the end time of the specified end date.
If recurring field is set true, then this field should not be present.
|
string |
|
| id |
Unique identifier of this resource |
string |
Sortable |
| 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 |
| realization_id |
A unique identifier assigned by the system for realizing intent
This is a UUID generated by the system for realizing the entity object.
In most cases this should be same as 'unique_id' of the entity. However,
in some cases this can be different because of entities have migrated thier
unique identifier to NSX Policy intent objects later in the timeline and did
not use unique_id for realization. Realization id is helpful for users to
debug data path to correlate the configuration with corresponding intent.
|
string |
Readonly |
| recurring |
Firewall schedule recurring flag
Flag to indicate whether firewall schedule recurs or not. The default
value is true and it should be set to false when the firewall schedule
does not recur and is a one time time interval.
|
boolean |
Required
Default: "True" |
| relative_path |
Relative path of this object
Path relative from its parent |
string |
Readonly |
| resource_type |
Must be set to the value PolicyFirewallScheduler |
string |
|
| start_date |
Start date in MM/DD/YYYY
Start date on which schedule to start. Example, 02/22/2019.
|
string |
Required |
| start_time |
Start time
Time in 24 hour and minutes in multiple of 30. Example, 9:00. If
recurring field is set false, then this field must be present. The
schedule will start getting enforced from the start time of the
specified start date. If recurring field is set true, then this
field should not be present.
|
string |
|
| tags |
Opaque identifiers meaningful to the API user |
array of Tag |
Maximum items: 30 |
| time_interval |
Recurring time interval
The recurring time interval in a day during which the schedule will be
applicable. It should not be present when the recurring flag is false.
|
array of PolicyTimeIntervalValue |
Maximum items: 1 |
| timezone |
Host timezone
Host Timezone to be used to enforce firewall rules.
|
string |
Required
Enum: UTC, LOCAL |
| 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 |