Enterprise

Definition of the enterprise object. This is the top level object that represents an enterprise.

Overview

allowAdvancedQOSConfiguration boolean
allowedForwardingClasses list (A | B | C | D | E | F | G | H | NONE) deprecated  
allowedForwardingMode enum (DISABLED | LOCAL_AND_REMOTE | LOCAL_ONLY) read only  
allowGatewayManagement boolean
allowTrustedForwardingClass boolean
associatedEnterpriseSecurityID string read only  
associatedGroupKeyEncryptionProfileID string read only  
associatedKeyServerMonitorID string read only  
avatarData string
avatarType enum (BASE64 | COMPUTEDURL | URL)
BGPEnabled boolean read only   filterable  
blockedPageText string
creationDate string read only   autogenerated   orderable  
customerID integer
description string filterable  
DHCPLeaseInterval integer
dictionaryVersion integer filterable   orderable  
embeddedMetadata list read only   autogenerated  
enableApplicationPerformanceManagement boolean
encryptionManagementMode enum (DISABLED | MANAGED) read only  
enterpriseProfileID string
enterpriseType enum (AUDIT | CSP | NORMAL | SHARED | SYSTEM) read only   filterable  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
floatingIPsQuota integer
floatingIPsUsed integer
flowCollectionEnabled enum (DISABLED | ENABLED) filterable   orderable  
forwardingClass list
lastUpdatedBy string autogenerated  
lastUpdatedDate string read only   autogenerated   orderable  
LDAPAuthorizationEnabled boolean read only  
LDAPEnabled boolean read only  
localAS integer
name string required   filterable   orderable  
owner string autogenerated  
receiveMultiCastListID string read only  
sendMultiCastListID string read only  
sharedEnterprise boolean read only   deprecated   filterable  
statsProfileID string
threatIntelligenceEnabled enum (DISABLED | ENABLED) filterable   orderable  
threatPreventionManagementEnabled boolean read only   autogenerated  
useGlobalMAC boolean filterable   orderable  
virtualFirewallRulesEnabled boolean read only  
VNFManagementEnabled boolean read only  
webFilterEnabled boolean read only  

API Resource

/enterprises/id
delete get put

Parents

/enterprises
get post
/statisticsprofiles/id/enterprises
get put
/enterpriseprofiles/id/enterprises
get

Children

/enterprises/id/l2domains
get post
/enterprises/id/l2domaintemplates
get post
/enterprises/id/l4services
get post
/enterprises/id/l4servicegroups
get post
/enterprises/id/l7applicationsignatures
get
/enterprises/id/saasapplicationgroups
get post
/enterprises/id/saasapplicationtypes
get post
/enterprises/id/sapegressqosprofiles
get post
/enterprises/id/sapingressqosprofiles
get post
/enterprises/id/captiveportalprofiles
get post
/enterprises/id/ratelimiters
get post
/enterprises/id/gateways
get post
/enterprises/id/gatewayslocations
get
/enterprises/id/gatewaytemplates
get post
/enterprises/id/patnatpools
get
/enterprises/id/scheduledtestsuites
get post
/enterprises/id/icmpechotestdefinitions
get post
/enterprises/id/ldapconfigurations
get
/enterprises/id/idpprofiles
get post
/enterprises/id/webcategories
get post
/enterprises/id/webdomainnames
get post
/enterprises/id/redundancygroups
get post
/enterprises/id/deploymentfailures
get
/enterprises/id/performancemonitors
get post
/enterprises/id/permissions
delete get post put
/enterprises/id/testdefinitions
get post
/enterprises/id/testsuites
get post
/enterprises/id/metadatas
get post
/enterprises/id/netconfprofiles
get post
/enterprises/id/networkmacrogroups
get post
/enterprises/id/networkperformancemeasurements
get post
/enterprises/id/keyservermonitors
get
/enterprises/id/zfbrequests
get post
/enterprises/id/bgpprofiles
get post
/enterprises/id/egressprofiles
get post
/enterprises/id/egressqospolicies
get post
/enterprises/id/sharednetworkresources
get
/enterprises/id/firewallacls
get post
/enterprises/id/firewallrules
get post
/enterprises/id/ikecertificates
get post
/enterprises/id/ikeencryptionprofiles
get post
/enterprises/id/ikegateways
get post
/enterprises/id/ikegatewayprofiles
get post
/enterprises/id/ikepsks
get post
/enterprises/id/alarms
get
/enterprises/id/allalarms
get
/enterprises/id/globalmetadatas
get post
/enterprises/id/vms
get
/enterprises/id/vnfs
get post
/enterprises/id/vnfmetadatas
get post
/enterprises/id/vnfthresholdpolicies
get post
/enterprises/id/ingressprofiles
get post
/enterprises/id/ingressqospolicies
get post
/enterprises/id/gnmiprofiles
get post
/enterprises/id/enterprisenetworks
get post
/enterprises/id/enterprisesecurities
get
/enterprises/id/jobs
get post
/enterprises/id/roles
get
/enterprises/id/policygroupcategories
get post
/enterprises/id/policyobjectgroups
get post
/enterprises/id/domains
get post
/enterprises/id/domainkindsummaries
get
/enterprises/id/domaintemplates
get post
/enterprises/id/containers
get
/enterprises/id/cosremarkingpolicytables
get post
/enterprises/id/routingpolicies
get post
/enterprises/id/ipfilterprofiles
get post
/enterprises/id/applications
get post
/enterprises/id/applicationperformancemanagements
get post
/enterprises/id/ipv6filterprofiles
get post
/enterprises/id/groups
get post
/enterprises/id/groupkeyencryptionprofiles
get
/enterprises/id/trunks
get post
/enterprises/id/dscpforwardingclasstables
get post
/enterprises/id/dscpremarkingpolicytables
get post
/enterprises/id/users
get post
/enterprises/id/nsgateways
get post
/enterprises/id/nsgatewayscounts
get
/enterprises/id/nsgatewayssummaries
get
/enterprises/id/nsgatewaytemplates
get
/enterprises/id/nsggroups
get post
/enterprises/id/nsgredundancygroups
get post
/enterprises/id/ethernetsegmentgwgroups
get post
/enterprises/id/publicnetworks
get post
/enterprises/id/multicastlists
get
/enterprises/id/avatars
get post
/enterprises/id/eventlogs
get
/enterprises/id/overlaymanagementprofiles
get post
/enterprises/id/syslogdestinations
get post
/enterprises/id/azureclouds
get post

Members

This object has no members.

Attributes documentation

allowAdvancedQOSConfiguration boolean
Discussion

Controls whether this enterprise has access to advanced QoS settings

Charateristics

Format: free
SDK attribute: allowAdvancedQOSConfiguration

allowedForwardingClasses list deprecated  
Discussion

Allowed Forwarding Classes for this enterprise. Possible values are NONE, A, B, C, D, E, F, G, H, .

Charateristics

Allowed values: A, B, C, D, E, F, G, H, NONE
SDK attribute: allowedForwardingClasses

allowedForwardingMode enum read only  
Discussion

Enum to set allowed controller-less mode

Charateristics

Allowed values: DISABLED, LOCAL_AND_REMOTE, LOCAL_ONLY
SDK attribute: allowedForwardingMode

allowGatewayManagement boolean
Discussion

This flag indicates if the enterprise/organization can manage gateways. If yes then it can create gateway templates, instantiate them etc.

Charateristics

Format: free
SDK attribute: allowGatewayManagement

allowTrustedForwardingClass boolean
Discussion

Controls whether QoS policies and templates created under this enterprise set the trusted flag to true

Charateristics

Format: free
SDK attribute: allowTrustedForwardingClass

associatedEnterpriseSecurityID string read only  
Discussion

Read-only Id of the associated group key encryption profile

Charateristics

Format: free
SDK attribute: associatedEnterpriseSecurityID

associatedGroupKeyEncryptionProfileID string read only  
Discussion

Read-only Id of the associated group key encryption profile

Charateristics

Format: free
SDK attribute: associatedGroupKeyEncryptionProfileID

associatedKeyServerMonitorID string read only  
Discussion

Read-only Id of the associated keyserver monitor

Charateristics

Format: free
SDK attribute: associatedKeyServerMonitorID

avatarData string
Discussion

URL to the avatar data associated with the enterprise. If the avatarType is URL then value of avatarData should an URL of the image. If the avatarType BASE64 then avatarData should be BASE64 encoded value of the image

Charateristics

Format: free
SDK attribute: avatarData

avatarType enum
Discussion

Avatar type - URL or BASE64 Possible values are URL, BASE64, COMPUTEDURL, .

Charateristics

Allowed values: BASE64, COMPUTEDURL, URL
SDK attribute: avatarType

BGPEnabled boolean read only   filterable  
Discussion

Read-only flag to display if BGP is enabled for this enterprise

Charateristics

SDK attribute: BGPEnabled

blockedPageText string
Discussion

The text for blocked page html which gets displayed to the end-users when they reach a website that is blocked by Web Filtering ACL. User can possibly include very basic html tags like

,

    etc. in order to fomat the text displayed to the end-users.

    Charateristics

    Format: free
    Max length: 4000
    SDK attribute: blockedPageText

creationDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was created.

Charateristics

SDK attribute: creationDate

customerID integer
Discussion

CustomerID that is used by VSC to identify this enterprise. This can be configured by root user.

Charateristics

Min value: 10000
Max value: 2147483647
SDK attribute: customerID

description string filterable  
Discussion

A description of the enterprise

Charateristics

Format: free
Max length: 255
SDK attribute: description

DHCPLeaseInterval integer
Discussion

DHCP Lease Interval (in hrs) to be used by an enterprise.

Charateristics

Format: free
SDK attribute: DHCPLeaseInterval

dictionaryVersion integer filterable   orderable  
Discussion

L7 Application Type version

Charateristics

Default value: 2
SDK attribute: dictionaryVersion

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

enableApplicationPerformanceManagement boolean
Discussion

This flag indicates if the DPI can be enabled for this enterpriseenterprise/organization.

Charateristics

Default value: false
SDK attribute: enableApplicationPerformanceManagement

encryptionManagementMode enum read only  
Discussion

Read-only encryption management mode of the associated profile

Charateristics

Allowed values: DISABLED, MANAGED
SDK attribute: encryptionManagementMode

enterpriseProfileID string
Discussion

Enterprise profile id for this enterprise

Charateristics

Format: free
SDK attribute: enterpriseProfileID

enterpriseType enum read only   filterable  
Discussion

Type of Enterprise. SHARED, AUDIT, NORMAL, CSP, SYSTEM

Charateristics

Allowed values: AUDIT, CSP, NORMAL, SHARED, SYSTEM
Default value: NORMAL
SDK attribute: enterpriseType

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems

Charateristics

Format: free
SDK attribute: externalID

floatingIPsQuota integer
Discussion

Quota set for the number of floating IPs to be used by an enterprise.

Charateristics

Max value: 1000000
SDK attribute: floatingIPsQuota

floatingIPsUsed integer
Discussion

Number of floating IPs used by the enterprise from the assigned floatingIPsQuota

Charateristics

SDK attribute: floatingIPsUsed

flowCollectionEnabled enum filterable   orderable  
Discussion

Determines whether or not flow collection is enabled.

Charateristics

Allowed values: DISABLED, ENABLED
Default value: DISABLED
SDK attribute: flowCollectionEnabled

forwardingClass list
Discussion

Represents the List of forwarding classes and their load balancing capability.

Charateristics

SDK attribute: forwardingClass

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

lastUpdatedDate string read only   autogenerated   orderable  
Discussion

Time stamp when this object was last updated.

Charateristics

SDK attribute: lastUpdatedDate

LDAPAuthorizationEnabled boolean read only  
Discussion

Read-only flag - indicates if LDAP is used for authorization for the enterprise. For detailed explanation, see definition in LDAPConfiguration class

Charateristics

SDK attribute: LDAPAuthorizationEnabled

LDAPEnabled boolean read only  
Discussion

Read-only flag - indicates if LDAP is used for authentication for the enterprise. For detailed explanation, see definition in LDAPConfiguration class

Charateristics

SDK attribute: LDAPEnabled

localAS integer
Discussion

Local autonomous system for the enterprise

Charateristics

Min value: 1
Max value: 4294967295
SDK attribute: localAS

name string required   filterable   orderable  
Discussion

The unique name of the enterprise.

Charateristics

Allowed characters: regex:\w+[\w -]*
Format: free
Min length: 1
Max length: 255
SDK attribute: name

owner string autogenerated  
Discussion

Identifies the user that has created this object.

Charateristics

Format: free
SDK attribute: owner

receiveMultiCastListID string read only  
Discussion

Read-only Id of the auto generated receive multicast list associated with this enterprise profile

Charateristics

Format: free
SDK attribute: receiveMultiCastListID

sendMultiCastListID string read only  
Discussion

Read-only Id of the auto generated send multicast list associated with this enterprise profile

Charateristics

Format: free
SDK attribute: sendMultiCastListID

sharedEnterprise boolean read only   deprecated   filterable  
Discussion

This flag indicates whether this is a Shared Infrastructure Enterprise or not. Its a read-only attribute and it cannot be set by anybody.

Charateristics

SDK attribute: sharedEnterprise

statsProfileID string
Discussion

Statistics Profile to which this enterprise is associated to.

Charateristics

Format: free
Max length: 255
SDK attribute: statsProfileID

threatIntelligenceEnabled enum filterable   orderable  
Discussion

Determines whether or not threat intelligence is enabled

Charateristics

Allowed values: DISABLED, ENABLED
Default value: DISABLED
SDK attribute: threatIntelligenceEnabled

threatPreventionManagementEnabled boolean read only   autogenerated  
Discussion

Threat Prevention Management enabled for enterprise

Charateristics

Default value: false
SDK attribute: threatPreventionManagementEnabled

useGlobalMAC boolean filterable   orderable  
Discussion

Determines whether Global Gateway MAC is enabled or not Enterprise level.

Charateristics

Default value: false
SDK attribute: useGlobalMAC

virtualFirewallRulesEnabled boolean read only  
Discussion

Read-only flag that indicates if virtual firewall rules are allowed.

Charateristics

Default value: false
SDK attribute: virtualFirewallRulesEnabled

VNFManagementEnabled boolean read only  
Discussion

Read-only flag to display if VNF management is enabled for this enterprise

Charateristics

Default value: false
SDK attribute: VNFManagementEnabled

webFilterEnabled boolean read only  
Discussion

Read only flag to display if Web Filtering is enabled for this enterprise

Charateristics

Default value: false
SDK attribute: webFilterEnabled