Tenant (object)

Declares a Tenant

Properties (* = required):

name type(s) default allowed values description
/*/ object     Application declaration main schema
class* string   “Tenant”  
constants object     Named values for (re-)use by declaration objects
controls object     Options to control configuration process
defaultRouteDomain integer 0 0 - 65535 Selects the default route domain for IP traffic to and from this Tenant’s application resources (note: affects declared IP addresses which do not include a %RD route-domain specifier). You must choose an existing route domain–this option cannot create one. Route domain 0 (default) is always available
enable boolean true true, false Tenant handles traffic only when enabled (default)
label string   “^[^x00-x1fx22#&*<>?x5b-x5d`x7f]*$” Optional friendly name for this object. Allows 0-64 chars, excluding a few likely to cause trouble with string searching, JS, TCL, or HTML
optimisticLockKey string “”   When you deploy a declaration with a non-empty ‘key’ value here, that activates an optimistic lock on changes to this Tenant. If the key in your declaration does not match the key AS3 computes for the most-recent previous declaration, then AS3 will NOT update this Tenant and will return an error code. To use optimistic locking, first retrieve a declaration using option ‘showHash=true’ to get the current per-Tenant keys. Make any changes you desire, then deploy your updated declaration. Deployment of each Tenant with a key will succeed only if that Tenant has not been modified since the time you retrieved the declaration. (To overwrite all previous changes to a Tenant simply do NOT include any opportunistic-lock key for that Tenant when you deploy a declaration. That is the default.) Note that only keys computed by AS3 may be used here– you cannot generate your own. If ‘showHash=true’ is used on a POST then the optimisticLockKey will be shown as a part of the output (This helps to avoid the need to do a GET request).
remark string   “^[^x00-x1fx22x5cx7f]*$” Arbitrary (brief) text pertaining to this object. Allows 0-64 chars, excluding only control characters, double-quote, and backslash. This is permissive enough that you should worry about XSS attacks
Shared object     Special application Shared holds objects other applications can share,Application declaration main schema
verifiers object     Data (in ‘key’:’value’ properties) used to verify automated tests. Ordinary declarations do not need this

Tenant./*/ (object)

Application declaration main schema

Properties (* = required):

name type(s) default allowed values description
/*/        
class* string   “Application”  
constants object     Named values for (re-)use by declaration objects
enable boolean true true, false Application handles traffic only when enabled (default)
label string   “^[^x00-x1fx22#&*<>?x5b-x5d`x7f]*$” Optional friendly name for this object. Allows 0-64 chars, excluding a few likely to cause trouble with string searching, JS, TCL, or HTML
remark string   “^[^x00-x1fx22x5cx7f]*$” Arbitrary (brief) text pertaining to this object. Allows 0-64 chars, excluding only control characters, double-quote, and backslash. This is permissive enough that you should worry about XSS attacks
schemaOverlay string     BIG-IQ name for a supplemental validation schema is applied to the Application class definition before the main AS3 schema
serviceMain       Primary service of the application
template string “generic”   Each application type has certain required and default elements and selects appropriate setup of various ADC/Security features

Tenant./*/.constants (object)

Named values for (re-)use by declaration objects

Properties (* = required):

name type(s) default allowed values description
/*/ boolean, integer, number, string, array, object   true, false, -∞ - -Infinity  
class* string   “Constants”  

Tenant./*/.constants./*/ (boolean, integer, number, string, array, object)

Allowed values: true, false, -∞ - -Infinity

Tenant.constants (object)

Named values for (re-)use by declaration objects

Properties (* = required):

name type(s) default allowed values description
/*/ boolean, integer, number, string, array, object   true, false, -∞ - -Infinity  
class* string   “Constants”  

Tenant.constants./*/ (boolean, integer, number, string, array, object)

Allowed values: true, false, -∞ - -Infinity

Tenant.controls (object)

Options to control configuration process

Properties (* = required):

name type(s) default allowed values description
class string “Controls” “Controls”  
fortune boolean false true, false If true, AS3 will activate Zoltar mode and read you your fortune
logLevel string “error” “emergency”, “alert”, “critical”, “error”, “warning”, “notice”, “info”, “debug” Controls the amount of detail in logs produced while configuring this Tenant (default is whole-declaration Controls/logLevel value)
trace boolean false true, false If true, AS3 creates a detailed trace of the configuration process for this Tenant for subsequent analysis (default is whole-declaration Controls/trace value). Warning: trace files may contain sensitive configuration data
traceResponse boolean false true, false If true, the response will contain the trace files

Tenant.Shared (object)

Special application Shared holds objects other applications can share Application declaration main schema

Properties (* = required):

name type(s) default allowed values description
/*/        
class* string   “Application”  
constants object     Named values for (re-)use by declaration objects
enable boolean true true, false Application handles traffic only when enabled (default)
label string   “^[^x00-x1fx22#&*<>?x5b-x5d`x7f]*$” Optional friendly name for this object. Allows 0-64 chars, excluding a few likely to cause trouble with string searching, JS, TCL, or HTML
remark string   “^[^x00-x1fx22x5cx7f]*$” Arbitrary (brief) text pertaining to this object. Allows 0-64 chars, excluding only control characters, double-quote, and backslash. This is permissive enough that you should worry about XSS attacks
schemaOverlay string     BIG-IQ name for a supplemental validation schema is applied to the Application class definition before the main AS3 schema
serviceMain       Primary service of the application
template* string “generic”   Each application type has certain required and default elements and selects appropriate setup of various ADC/Security features

Tenant.Shared.constants (object)

Named values for (re-)use by declaration objects

Properties (* = required):

name type(s) default allowed values description
/*/ boolean, integer, number, string, array, object   true, false, -∞ - -Infinity  
class* string   “Constants”  

Tenant.Shared.constants./*/ (boolean, integer, number, string, array, object)

Allowed values: true, false, -∞ - -Infinity

Tenant.verifiers (object)

Data (in ‘key’:’value’ properties) used to verify automated tests. Ordinary declarations do not need this