policy

Documentation

Index

• type Policydataset
• type Policydatasetbinding
• type Policydatasetvaluebinding
• type Policyevaluation
• type Policyexpression
• type Policyhttpcallout
• type Policymap
• type Policyparam
• type Policypatset
• type Policypatsetbinding
• type Policypatsetfile
• type Policypatsetpatternbinding
• type Policystringmap
• type Policystringmapbinding
• type Policystringmappatternbinding
• type Policyurlset

Types

type Policydataset

type Policydataset struct {
	/**
	* Name of the dataset. Must not exceed 127 characters.
	 */
	Name string `json:"name,omitempty"`
	/**
	* Type of value to bind to the dataset.
	 */
	Type string `json:"type,omitempty"`
	/**
	* Index type.
	 */
	Indextype string `json:"indextype,omitempty"`
	/**
	* Any comments to preserve information about this dataset or a data bound to this dataset.
	 */
	Comment string `json:"comment,omitempty"`
	/**
	* File which contains list of patterns that needs to be bound to the dataset. A patsetfile cannot be associated with multiple datasets.
	 */
	Patsetfile string `json:"patsetfile,omitempty"`

	Description string `json:"description,omitempty"`
}

* * Configuration for TYPE set resource.

type Policydatasetbinding

type Policydatasetbinding struct {
	/**
	* Name of the dataset. Must not exceed 127 characters.<br/>Minimum value =
	 */
	Name string `json:"name,omitempty"`
}

* * Binding object which returns the resources bound to policydataset_binding.

type Policydatasetvaluebinding

type Policydatasetvaluebinding struct {
	/**
	* Value of the specified type that is associated with the dataset.
	 */
	Value string `json:"value,omitempty"`
	/**
	* The index of the value (ipv4, ipv6, number) associated with the set.
	 */
	Index int `json:"index,omitempty"`
	/**
	* Any comments to preserve information about this dataset or a data bound to this dataset.
	 */
	Comment string `json:"comment,omitempty"`
	/**
	* The dataset entry is a range from <value> through <end_range>, inclusive
	 */
	Endrange string `json:"endrange,omitempty"`
	/**
	* Name of the dataset to which to bind the value.
	 */
	Name string `json:"name,omitempty"`
}

* * Binding class showing the value that can be bound to policydataset.

type Policyevaluation

type Policyevaluation struct {
	/**
	* Expression string. For example: http.req.body(100).contains("this").
	 */
	Expression string `json:"expression,omitempty"`
	/**
	* Rewrite action name. Supported rewrite action types are:
		-delete
		-delete_all
		-delete_http_header
		-insert_after
		-insert_after_all
		-insert_before
		-insert_before_all
		-insert_http_header
		-replace
		-replace_all
	*/
	Action string `json:"action,omitempty"`
	/**
	* Indicates request or response input packet
	 */
	Type string `json:"type,omitempty"`
	/**
	* Text representation of input packet.
	 */
	Input string `json:"input,omitempty"`

	Pitmodifiedinputdata       string `json:"pitmodifiedinputdata,omitempty"`
	Pitboolresult              string `json:"pitboolresult,omitempty"`
	Pitnumresult               string `json:"pitnumresult,omitempty"`
	Pitdoubleresult            string `json:"pitdoubleresult,omitempty"`
	Pitulongresult             string `json:"pitulongresult,omitempty"`
	Pitrefresult               string `json:"pitrefresult,omitempty"`
	Pitoffsetresult            string `json:"pitoffsetresult,omitempty"`
	Pitoffsetresultlen         string `json:"pitoffsetresultlen,omitempty"`
	Istruncatedrefresult       string `json:"istruncatedrefresult,omitempty"`
	Pitboolevaltime            string `json:"pitboolevaltime,omitempty"`
	Pitnumevaltime             string `json:"pitnumevaltime,omitempty"`
	Pitdoubleevaltime          string `json:"pitdoubleevaltime,omitempty"`
	Pitulongevaltime           string `json:"pitulongevaltime,omitempty"`
	Pitrefevaltime             string `json:"pitrefevaltime,omitempty"`
	Pitoffsetevaltime          string `json:"pitoffsetevaltime,omitempty"`
	Pitactionevaltime          string `json:"pitactionevaltime,omitempty"`
	Pitoperationperformerarray string `json:"pitoperationperformerarray,omitempty"`
	Pitoldoffsetarray          string `json:"pitoldoffsetarray,omitempty"`
	Pitnewoffsetarray          string `json:"pitnewoffsetarray,omitempty"`
	Pitoffsetlengtharray       string `json:"pitoffsetlengtharray,omitempty"`
	Pitoffsetnewlengtharray    string `json:"pitoffsetnewlengtharray,omitempty"`
	Pitboolerrorresult         string `json:"pitboolerrorresult,omitempty"`
	Pitnumerrorresult          string `json:"pitnumerrorresult,omitempty"`
	Pitdoubleerrorresult       string `json:"pitdoubleerrorresult,omitempty"`
	Pitulongerrorresult        string `json:"pitulongerrorresult,omitempty"`
	Pitreferrorresult          string `json:"pitreferrorresult,omitempty"`
	Pitoffseterrorresult       string `json:"pitoffseterrorresult,omitempty"`
	Pitactionerrorresult       string `json:"pitactionerrorresult,omitempty"`
}

* * Configuration for expr evaluation resource.

type Policyexpression

type Policyexpression struct {
	/**
	* Unique name for the expression. Not case sensitive. Must begin with an ASCII letter or underscore (_) character, and must consist only of ASCII alphanumeric or underscore characters. Must not begin with 're' or 'xp' or be a word reserved for use as an expression qualifier prefix (such as HTTP) or enumeration value (such as ASCII). Must not be the name of an existing named expression, pattern set, dataset, stringmap, or HTTP callout.
	 */
	Name string `json:"name,omitempty"`
	/**
	* Expression string. For example: http.req.body(100).contains("this").
	 */
	Value string `json:"value,omitempty"`
	/**
	* Description for the expression.
	 */
	Description string `json:"description,omitempty"`
	/**
	* Any comments associated with the expression. Displayed upon viewing the policy expression.
	 */
	Comment string `json:"comment,omitempty"`
	/**
	* Message to display if the expression fails. Allowed for classic end-point check expressions only.
	 */
	Clientsecuritymessage string `json:"clientsecuritymessage,omitempty"`
	/**
	* Type of expression. Can be a classic or default syntax (advanced) expression.
	 */
	Type string `json:"type,omitempty"`

	Hits      string `json:"hits,omitempty"`
	Pihits    string `json:"pihits,omitempty"`
	Type1     string `json:"type1,omitempty"`
	Isdefault string `json:"isdefault,omitempty"`
	Builtin   string `json:"builtin,omitempty"`
	Feature   string `json:"feature,omitempty"`
}

* * Configuration for expression resource.

type Policyhttpcallout

type Policyhttpcallout struct {
	/**
	* Name for the HTTP callout. Not case sensitive. Must begin with an ASCII letter or underscore (_) character, and must consist only of ASCII alphanumeric or underscore characters. Must not begin with 're' or 'xp' or be a word reserved for use as an expression qualifier prefix (such as HTTP) or enumeration value (such as ASCII). Must not be the name of an existing named expression, pattern set, dataset, stringmap, or HTTP callout.
	 */
	Name string `json:"name,omitempty"`
	/**
	* IP Address of the server (callout agent) to which the callout is sent. Can be an IPv4 or IPv6 address.
		Mutually exclusive with the Virtual Server parameter. Therefore, you cannot set the <IP Address, Port> and the Virtual Server in the same HTTP callout.
	*/
	Ipaddress string `json:"ipaddress,omitempty"`
	/**
	* Server port to which the HTTP callout agent is mapped. Mutually exclusive with the Virtual Server parameter. Therefore, you cannot set the <IP Address, Port> and the Virtual Server in the same HTTP callout.
	 */
	Port int `json:"port,omitempty"`
	/**
	* Name of the load balancing, content switching, or cache redirection virtual server (the callout agent) to which the HTTP callout is sent. The service type of the virtual server must be HTTP. Mutually exclusive with the IP address and port parameters. Therefore, you cannot set the <IP Address, Port> and the Virtual Server in the same HTTP callout.
	 */
	Vserver string `json:"vserver,omitempty"`
	/**
	* Type of data that the target callout agent returns in response to the callout.
		Available settings function as follows:
		* TEXT - Treat the returned value as a text string.
		* NUM - Treat the returned value as a number.
		* BOOL - Treat the returned value as a Boolean value.
		Note: You cannot change the return type after it is set.
	*/
	Returntype string `json:"returntype,omitempty"`
	/**
	* Method used in the HTTP request that this callout sends.  Mutually exclusive with the full HTTP request expression.
	 */
	Httpmethod string `json:"httpmethod,omitempty"`
	/**
	* String expression to configure the Host header. Can contain a literal value (for example, 10.101.10.11) or a derived value (for example, http.req.header("Host")). The literal value can be an IP address or a fully qualified domain name. Mutually exclusive with the full HTTP request expression.
	 */
	Hostexpr string `json:"hostexpr,omitempty"`
	/**
	* String expression for generating the URL stem. Can contain a literal string (for example, "/mysite/index.html") or an expression that derives the value (for example, http.req.url). Mutually exclusive with the full HTTP request expression.
	 */
	Urlstemexpr string `json:"urlstemexpr,omitempty"`
	/**
	* One or more headers to insert into the HTTP request. Each header is specified as "name(expr)", where expr is an expression that is evaluated at runtime to provide the value for the named header. You can configure a maximum of eight headers for an HTTP callout. Mutually exclusive with the full HTTP request expression.
	 */
	Headers []string `json:"headers,omitempty"`
	/**
	* One or more query parameters to insert into the HTTP request URL (for a GET request) or into the request body (for a POST request). Each parameter is specified as "name(expr)", where expr is an expression that is evaluated at run time to provide the value for the named parameter (name=value). The parameter values are URL encoded. Mutually exclusive with the full HTTP request expression.
	 */
	Parameters []string `json:"parameters,omitempty"`
	/**
	* An advanced string expression for generating the body of the request. The expression can contain a literal string or an expression that derives the value (for example, client.ip.src). Mutually exclusive with -fullReqExpr.
	 */
	Bodyexpr string `json:"bodyexpr,omitempty"`
	/**
	* Exact HTTP request, in the form of an expression, which the Citrix ADC sends to the callout agent. If you set this parameter, you must not include HTTP method, host expression, URL stem expression, headers, or parameters.
		The request expression is constrained by the feature for which the callout is used. For example, an HTTP.RES expression cannot be used in a request-time policy bank or in a TCP content switching policy bank.
		The Citrix ADC does not check the validity of this request. You must manually validate the request.
	*/
	Fullreqexpr string `json:"fullreqexpr,omitempty"`
	/**
	* Type of scheme for the callout server.
	 */
	Scheme string `json:"scheme,omitempty"`
	/**
	* Expression that extracts the callout results from the response sent by the HTTP callout agent. Must be a response based expression, that is, it must begin with HTTP.RES. The operations in this expression must match the return type. For example, if you configure a return type of TEXT, the result expression must be a text based expression. If the return type is NUM, the result expression (resultExpr) must return a numeric value, as in the following example: http.res.body(10000).length.
	 */
	Resultexpr string `json:"resultexpr,omitempty"`
	/**
	* Duration, in seconds, for which the callout response is cached. The cached responses are stored in an integrated caching content group named "calloutContentGroup". If no duration is configured, the callout responses will not be cached unless normal caching configuration is used to cache them. This parameter takes precedence over any normal caching configuration that would otherwise apply to these responses.
		Note that the calloutContentGroup definition may not be modified or removed nor may it be used with other cache policies.
	*/
	Cacheforsecs int `json:"cacheforsecs,omitempty"`
	/**
	* Any comments to preserve information about this HTTP callout.
	 */
	Comment string `json:"comment,omitempty"`

	Hits             string `json:"hits,omitempty"`
	Undefhits        string `json:"undefhits,omitempty"`
	Svrstate         string `json:"svrstate,omitempty"`
	Effectivestate   string `json:"effectivestate,omitempty"`
	Undefreason      string `json:"undefreason,omitempty"`
	Recursivecallout string `json:"recursivecallout,omitempty"`
}

* * Configuration for HTTP callout resource.

type Policymap

type Policymap struct {
	/**
	* Name for the map policy. Must begin with a letter, number, or the underscore (_) character and must consist only of letters, numbers, and the hash (#), period (.), colon (:), space ( ), at (@), equals (=), hyphen (-), and underscore (_) characters.
		CLI Users: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my map" or 'my map').
	*/
	Mappolicyname string `json:"mappolicyname,omitempty"`
	/**
	* Publicly known source domain name. This is the domain name with which a client request arrives at a reverse proxy virtual server for cache redirection. If you specify a source domain, you must specify a target domain.
	 */
	Sd string `json:"sd,omitempty"`
	/**
	* Source URL. Specify all or part of the source URL, in the following format: /[[prefix] [*]] [.suffix].
	 */
	Su string `json:"su,omitempty"`
	/**
	* Target domain name sent to the server. The source domain name is replaced with this domain name.
	 */
	Td string `json:"td,omitempty"`
	/**
	* Target URL. Specify the target URL in the following format: /[[prefix] [*]][.suffix].
	 */
	Tu string `json:"tu,omitempty"`

	Targetname string `json:"targetname,omitempty"`
}

* * Configuration for map policy resource.

type Policyparam

type Policyparam struct {
	/**
	* Maximum time in milliseconds to allow for processing expressions without interruption. If the timeout is reached then the evaluation causes an UNDEF to be raised and no further processing is performed.
	 */
	Timeout int `json:"timeout,omitempty"`
}

* * Configuration for policy parameter resource.

type Policypatset

type Policypatset struct {
	/**
	* Unique name of the pattern set. Not case sensitive. Must begin with an ASCII letter or underscore (_) character and must contain only alphanumeric and underscore characters. Must not be the name of an existing named expression, pattern set, dataset, string map, or HTTP callout.
	 */
	Name string `json:"name,omitempty"`
	/**
	* Index type.
	 */
	Indextype string `json:"indextype,omitempty"`
	/**
	* Any comments to preserve information about this patset or a pattern bound to this patset.
	 */
	Comment string `json:"comment,omitempty"`
	/**
	* File which contains list of patterns that needs to be bound to the patset. A patsetfile cannot be associated with multiple patsets.
	 */
	Patsetfile string `json:"patsetfile,omitempty"`

	Description string `json:"description,omitempty"`
}

* * Configuration for PAT set resource.

type Policypatsetbinding

type Policypatsetbinding struct {
	/**
	* Name of the pattern set for which to display the detailed information. If a name is not provided, a list of all pattern sets configured on the appliance is shown.<br/>Minimum value =
	 */
	Name string `json:"name,omitempty"`
}

* * Binding object which returns the resources bound to policypatset_binding.

type Policypatsetfile

type Policypatsetfile struct {
	/**
	* URL in protocol, host, path, and file name format from where the patset file will be imported. If file is already present, then it can be imported using local keyword (import patsetfile local:filename patsetfile1)
		NOTE: The import fails if the object to be imported is on an HTTPS server that requires client certificate authentication for access
	*/
	Src string `json:"src,omitempty"`
	/**
	* Name to assign to the imported patset file. Unique name of the pattern set. Not case sensitive. Must begin with an ASCII letter or underscore (_) character and must contain only alphanumeric and underscore characters.
	 */
	Name string `json:"name,omitempty"`
	/**
	* Overwrites the existing file
	 */
	Overwrite bool `json:"overwrite,omitempty"`
	/**
	* patset file patterns delimiter.
	 */
	Delimiter string `json:"delimiter,omitempty"`
	/**
	* Character set associated with the characters in the string.
	 */
	Charset string `json:"charset,omitempty"`
	/**
	* Any comments to preserve information about this patsetfile.
	 */
	Comment string `json:"comment,omitempty"`
	/**
	* When set, display only shows all imported patsetfiles.
	 */
	Imported bool `json:"imported,omitempty"`

	Totalpatterns  string `json:"totalpatterns,omitempty"`
	Boundpatterns  string `json:"boundpatterns,omitempty"`
	Patsetname     string `json:"patsetname,omitempty"`
	Bindstatuscode string `json:"bindstatuscode,omitempty"`
	Bindstatus     string `json:"bindstatus,omitempty"`
}

* * Configuration for patset file resource.

type Policypatsetpatternbinding

type Policypatsetpatternbinding struct {
	/**
	* String of characters that constitutes a pattern. For more information about the characters that can be used, refer to the character set parameter.
		Note: Minimum length for pattern sets used in rewrite actions of type REPLACE_ALL, DELETE_ALL, INSERT_AFTER_ALL, and INSERT_BEFORE_ALL, is three characters.
	*/
	String string `json:"String,omitempty"`
	/**
	* The index of the string associated with the patset.
	 */
	Index int `json:"index,omitempty"`
	/**
	* Character set associated with the characters in the string.
		Note: UTF-8 characters can be entered directly (if the UI supports it) or can be encoded as a sequence of hexadecimal bytes '\xNN'. For example, the UTF-8 character 'ue' can be encoded as '\xC3\xBC'.
	*/
	Charset string `json:"charset,omitempty"`
	/**
	* Any comments to preserve information about this patset or a pattern bound to this patset.
	 */
	Comment string `json:"comment,omitempty"`
	/**
	* Indicates that a variable is a built-in (SYSTEM INTERNAL) type.
	 */
	Builtin []string `json:"builtin,omitempty"`
	/**
	* The feature to be checked while applying this config
	 */
	Feature string `json:"feature,omitempty"`
	/**
	* Name of the pattern set to which to bind the string.
	 */
	Name string `json:"name,omitempty"`
}

* * Binding class showing the pattern that can be bound to policypatset.

type Policystringmap

type Policystringmap struct {
	/**
	* Unique name for the string map. Not case sensitive. Must begin with an ASCII letter or underscore (_) character, and must consist only of ASCII alphanumeric or underscore characters. Must not begin with 're' or 'xp' or be a word reserved for use as an expression qualifier prefix (such as HTTP) or enumeration value (such as ASCII). Must not be the name of an existing named expression, pattern set, dataset, string map, or HTTP callout.
	 */
	Name string `json:"name,omitempty"`
	/**
	* Comments associated with the string map or key-value pair bound to this string map.
	 */
	Comment string `json:"comment,omitempty"`
}

* * Configuration for string map resource.

type Policystringmapbinding

type Policystringmapbinding struct {
	/**
	* Name of the string map to display. If a name is not provided, a list of all the configured string maps is shown.<br/>Minimum value =
	 */
	Name string `json:"name,omitempty"`
}

* * Binding object which returns the resources bound to policystringmap_binding.

type Policystringmappatternbinding

type Policystringmappatternbinding struct {
	/**
	* Character string constituting the key to be bound to the string map. The key is matched against the data processed by the operation that uses the string map. The default character set is ASCII. UTF-8 characters can be included if the character set is UTF-8.  UTF-8 characters can be entered directly (if the UI supports it) or can be encoded as a sequence of hexadecimal bytes '\xNN'. For example, the UTF-8 character 'ue' can be encoded as '\xC3\xBC'.
	 */
	Key string `json:"key,omitempty"`
	/**
	* Character string constituting the value associated with the key. This value is returned when processed data matches the associated key. Refer to the key parameter for details of the value character set.
	 */
	Value string `json:"value,omitempty"`
	/**
	* Comments associated with the string map or key-value pair bound to this string map.
	 */
	Comment string `json:"comment,omitempty"`
	/**
	* Name of the string map to which to bind the key-value pair.
	 */
	Name string `json:"name,omitempty"`
}

* * Binding class showing the pattern that can be bound to policystringmap.

type Policyurlset

type Policyurlset struct {
	/**
	* Unique name of the url set. Not case sensitive. Must begin with an ASCII letter or underscore (_) character and must contain only alphanumeric and underscore characters. Must not be the name of an existing named expression, pattern set, dataset, string map, or HTTP callout.
	 */
	Name string `json:"name,omitempty"`
	/**
	* Any comments to preserve information about this url set.
	 */
	Comment string `json:"comment,omitempty"`
	/**
	* when set, display shows all imported urlsets.
	 */
	Imported bool `json:"imported,omitempty"`
	/**
	* Overwrites the existing file.
	 */
	Overwrite bool `json:"overwrite,omitempty"`
	/**
	* CSV file record delimiter.
	 */
	Delimiter string `json:"delimiter,omitempty"`
	/**
	* CSV file row separator.
	 */
	Rowseparator string `json:"rowseparator,omitempty"`
	/**
	* URL (protocol, host, path and file name) from where the CSV (comma separated file) file will be imported or exported. Each record/line will one entry within the urlset. The first field contains the URL pattern, subsequent fields contains the metadata, if available. HTTP, HTTPS and FTP protocols are supported. NOTE: The operation fails if the destination HTTPS server requires client certificate authentication for access.
	 */
	Url string `json:"url,omitempty"`
	/**
	* The interval, in seconds, rounded down to the nearest 15 minutes, at which the update of urlset occurs.
	 */
	Interval int `json:"interval,omitempty"`
	/**
	* Prevent this urlset from being exported.
	 */
	Privateset bool `json:"privateset,omitempty"`
	/**
	* Force exact subdomain matching, ex. given an entry 'google.com' in the urlset, a request to 'news.google.com' won't match, if subdomainExactMatch is set.
	 */
	Subdomainexactmatch bool `json:"subdomainexactmatch,omitempty"`
	/**
	* An ID that would be sent to AppFlow to indicate which URLSet was the last one that matched the requested URL.
	 */
	Matchedid int `json:"matchedid,omitempty"`
	/**
	* Add this URL to this urlset. Used for testing when contents of urlset is kept confidential.
	 */
	Canaryurl string `json:"canaryurl,omitempty"`

	Patterncount string `json:"patterncount,omitempty"`
}

* * Configuration for URL set resource.