Developer Documentation

PolicyFirewallSessionTimerProfile

A profile holding TCP, UDP and ICMP session timeout configuration.


Properties

Required Property Name Type Description
optional _create_time integer

Timestamp of resource creation

optional _create_user string

ID of the user who created this resource

optional _last_modified_time integer

Timestamp of last modification

optional _last_modified_user string

ID of the user who last modified this resource

optional _links array of ResourceLink

The server will populate this field when returing the resource. Ignored on PUT and POST.

optional _protection string

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.

optional _revision integer

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.

optional _schema string

Schema for this resource

optional _self SelfResourceLink

Link to this resource

optional _system_owned boolean

Indicates system owned resource

optional children array of ChildPolicyConfigResource

subtree for this type within policy tree containing nested elements.

optional description string

Description of this resource

optional display_name string

Defaults to ID if not set

optional icmp_error_reply integer

The timeout value for the connection after an ICMP error came back in response to an ICMP packet.

optional icmp_first_packet integer

The timeout value of connection in seconds after the first packet. This will be the initial timeout for the new ICMP flow.

optional id string

Unique identifier of this resource

optional marked_for_delete boolean

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.

optional parent_path string

Path of its parent

optional path string

Absolute path of this object

optional relative_path string

Path relative from its parent

optional resource_type string

The type of this resource.

optional tags array of Tag

Opaque identifiers meaningful to the API user

optional tcp_closed integer

The timeout value of connection in seconds after one endpoint sends an RST.

optional tcp_closing integer

The timeout value of connection in seconds after the first FIN has been sent.

optional tcp_established integer

The timeout value of connection in seconds once the connection has become fully established.

optional tcp_finwait integer

The timeout value of connection in seconds after both FINs have been exchanged and connection is closed.

optional tcp_first_packet integer

The timeout value of connection in seconds after the first packet has been sent.

optional tcp_opening integer

The timeout value of connection in seconds after a second packet has been transferred.

optional udp_first_packet integer

The timeout value of connection in seconds after the first packet. This will be the initial timeout for the new UDP flow.

optional udp_multiple integer

The timeout value of connection in seconds if both hosts have sent packets.

optional udp_single integer

The timeout value of connection in seconds if the source host sends more than one packet but the destination host has never sent one back.

Feedback

Was this page helpful?