UserContext

This defines a proxy class to expose some of the configuration parameters which are required by UI

Overview

AARFlowStatsInterval integer filterable   orderable  
AARProbeStatsInterval integer filterable   orderable  
deniedFlowCollectionEnabled boolean filterable   orderable  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
explicitACLMatchingEnabled boolean filterable   orderable  
externalID string filterable   orderable   locally unique  
flowCollectionEnabled boolean filterable   orderable  
googleMapsAPIKey string read only  
lastUpdatedBy string autogenerated  
pageSize integer read only  
statisticsEnabled boolean filterable   orderable  
statsDatabaseProxy string read only  
statsTSDBServerAddress string filterable   orderable  
threatIntelligenceEnabled boolean filterable   orderable  
VSSFeatureEnabled boolean read only   filterable   orderable  
VSSStatsInterval integer filterable   orderable  

API Resource

/usercontexts/id

Parents

/usercontexts
get

Children

/usercontexts/id/metadatas
get post
/usercontexts/id/globalmetadatas
get post put

Members

This object has no members.

Attributes documentation

AARFlowStatsInterval integer filterable   orderable  
Discussion

Interval for AAR flow stats


Charateristics

Default value: 30
Min value: 1
SDK attribute: AARFlowStatsInterval

AARProbeStatsInterval integer filterable   orderable  
Discussion

Interval for AAR probe stats


Charateristics

Default value: 30
Min value: 1
SDK attribute: AARProbeStatsInterval

deniedFlowCollectionEnabled boolean filterable   orderable  
Discussion

When this option is selected, VSS will only store flows that are denied by security policy (implicit or explicit ACLs). This requires a valid VSS license and Flow Collection enabled.


Charateristics

Default value: false
SDK attribute: deniedFlowCollectionEnabled

embeddedMetadata list read only   autogenerated  
Discussion

Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.


Charateristics

SDK attribute: embeddedMetadata

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level


Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

explicitACLMatchingEnabled boolean filterable   orderable  
Discussion

When this option is selected, VSS will only store allow/denied flows that matches explicit ingress/egress security ACL. This requires a valid VSS license and Flow Collection enabled.


Charateristics

Default value: false
SDK attribute: explicitACLMatchingEnabled

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems


Charateristics

Format: free
SDK attribute: externalID

flowCollectionEnabled boolean filterable   orderable  
Discussion

Enables flow statistics collection. It is needed for the VSS feature, and requires a valid VSS license. This option requires 'statisticsEnabled'.


Charateristics

SDK attribute: flowCollectionEnabled

googleMapsAPIKey string read only  
Discussion

Google Maps API Key used to display maps on Nuage UI applications


Charateristics

Format: free
Max length: 255
SDK attribute: googleMapsAPIKey

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.


Charateristics

Format: free
SDK attribute: lastUpdatedBy

pageSize integer read only  
Discussion

Result size for queries


Charateristics

Format: free
SDK attribute: pageSize

statisticsEnabled boolean filterable   orderable  
Discussion

This flag is used to indicate if statistics is enabled in the system. CSProot is expected to activate this through the enable statistics script.


Charateristics

SDK attribute: statisticsEnabled

statsDatabaseProxy string read only  
Discussion

The location of a public proxy to statistics database server in : format.


Charateristics

Format: free
SDK attribute: statsDatabaseProxy

statsTSDBServerAddress string filterable   orderable  
Discussion

IP address(es) of the elastic machine


Charateristics

Format: free
SDK attribute: statsTSDBServerAddress

threatIntelligenceEnabled boolean filterable   orderable  
Discussion

Enables IP based threat intelligence. This requires Flow Collection to be enabled


Charateristics

Default value: false
SDK attribute: threatIntelligenceEnabled

VSSFeatureEnabled boolean read only   filterable   orderable  
Discussion

Flag to indicate if VSS feature is enabled.


Charateristics

Default value: false
SDK attribute: VSSFeatureEnabled

VSSStatsInterval integer filterable   orderable  
Discussion

Interval for VSS stats


Charateristics

Default value: 30
Min value: 1
SDK attribute: VSSStatsInterval