Policy

f5bigip.ltm.Policy Configures Virtual Server

For resources should be named with their “full path”. The full path is the combination of the partition + name of the resource. For example /Common/my-pool.

Create a Policy Resource

new Policy(name: string, args: PolicyArgs, opts?: CustomResourceOptions);
def Policy(resource_name, opts=None, controls=None, name=None, published_copy=None, requires=None, rules=None, strategy=None, __props__=None);
func NewPolicy(ctx *Context, name string, args PolicyArgs, opts ...ResourceOption) (*Policy, error)
public Policy(string name, PolicyArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args PolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args PolicyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args PolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Policy Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Policy resource accepts the following input properties:

Name string

Name of the Policy

Controls List<string>

Specifies the controls

PublishedCopy string

If you want to publish the policy else it will be deployed in Drafts mode.

Requires List<string>

Specifies the protocol

Rules List<Pulumi.F5BigIP.Ltm.Inputs.PolicyRuleArgs>

Rules can be applied using the policy

Strategy string

Specifies the match strategy

Name string

Name of the Policy

Controls []string

Specifies the controls

PublishedCopy string

If you want to publish the policy else it will be deployed in Drafts mode.

Requires []string

Specifies the protocol

Rules []PolicyRule

Rules can be applied using the policy

Strategy string

Specifies the match strategy

name string

Name of the Policy

controls string[]

Specifies the controls

publishedCopy string

If you want to publish the policy else it will be deployed in Drafts mode.

requires string[]

Specifies the protocol

rules PolicyRule[]

Rules can be applied using the policy

strategy string

Specifies the match strategy

name str

Name of the Policy

controls List[str]

Specifies the controls

published_copy str

If you want to publish the policy else it will be deployed in Drafts mode.

requires List[str]

Specifies the protocol

rules List[PolicyRule]

Rules can be applied using the policy

strategy str

Specifies the match strategy

Outputs

All input properties are implicitly available as output properties. Additionally, the Policy resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.

Look up an Existing Policy Resource

Get an existing Policy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: PolicyState, opts?: CustomResourceOptions): Policy
static get(resource_name, id, opts=None, controls=None, name=None, published_copy=None, requires=None, rules=None, strategy=None, __props__=None);
func GetPolicy(ctx *Context, name string, id IDInput, state *PolicyState, opts ...ResourceOption) (*Policy, error)
public static Policy Get(string name, Input<string> id, PolicyState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

Controls List<string>

Specifies the controls

Name string

Name of the Policy

PublishedCopy string

If you want to publish the policy else it will be deployed in Drafts mode.

Requires List<string>

Specifies the protocol

Rules List<Pulumi.F5BigIP.Ltm.Inputs.PolicyRuleArgs>

Rules can be applied using the policy

Strategy string

Specifies the match strategy

Controls []string

Specifies the controls

Name string

Name of the Policy

PublishedCopy string

If you want to publish the policy else it will be deployed in Drafts mode.

Requires []string

Specifies the protocol

Rules []PolicyRule

Rules can be applied using the policy

Strategy string

Specifies the match strategy

controls string[]

Specifies the controls

name string

Name of the Policy

publishedCopy string

If you want to publish the policy else it will be deployed in Drafts mode.

requires string[]

Specifies the protocol

rules PolicyRule[]

Rules can be applied using the policy

strategy string

Specifies the match strategy

controls List[str]

Specifies the controls

name str

Name of the Policy

published_copy str

If you want to publish the policy else it will be deployed in Drafts mode.

requires List[str]

Specifies the protocol

rules List[PolicyRule]

Rules can be applied using the policy

strategy str

Specifies the match strategy

Supporting Types

PolicyRule

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Name string

Name of the Policy

Actions List<Pulumi.F5BigIP.Ltm.Inputs.PolicyRuleActionArgs>
Conditions List<Pulumi.F5BigIP.Ltm.Inputs.PolicyRuleConditionArgs>
Name string

Name of the Policy

Actions []PolicyRuleAction
Conditions []PolicyRuleCondition
name string

Name of the Policy

actions PolicyRuleAction[]
conditions PolicyRuleCondition[]
name str

Name of the Policy

actions List[PolicyRuleAction]
conditions List[PolicyRuleCondition]

PolicyRuleAction

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

AppService string
Application string
Asm bool
Avr bool
Cache bool
Carp bool
Category string
Classify bool
ClonePool string
Code int
Compress bool
Content string
CookieHash bool
CookieInsert bool
CookiePassive bool
CookieRewrite bool
Decompress bool
Defer bool
DestinationAddress bool
Disable bool
Domain string
Enable bool
Expiry string
ExpirySecs int
Expression string
Extension string
Facility string
Forward bool

This action will affect forwarding.

FromProfile string
Hash bool
Host string
Http bool
HttpBasicAuth bool
HttpCookie bool
HttpHeader bool
HttpHost bool
HttpReferer bool
HttpReply bool
HttpSetCookie bool
HttpUri bool
Ifile string
Insert bool
InternalVirtual string
IpAddress string
Key string
L7dos bool
Length int
Location string
Log bool
LtmPolicy bool
Member string
Message string
Netmask string
Nexthop string
Node string
Offset int
Path string
Pem bool
Persist bool
Pin bool
Policy string
Pool string

This action will direct the stream to this pool.

Port int
Priority string
Profile string
Protocol string
QueryString string
Rateclass string
Redirect bool
Remove bool
Replace bool
Request bool
RequestAdapt bool
Reset bool
Response bool
ResponseAdapt bool
Scheme string
Script string
Select bool
ServerSsl bool
SetVariable bool
Snat string
Snatpool string
SourceAddress bool
SslClientHello bool
SslServerHandshake bool
SslServerHello bool
SslSessionId bool
Status int
Tcl bool
TcpNagle bool
Text string
Timeout int
TmName string

If Rule is used then you need to provide the tm_name it can be any value

Uie bool
Universal bool
Value string
Virtual string
Vlan string
VlanId int
Wam bool
Write bool
AppService string
Application string
Asm bool
Avr bool
Cache bool
Carp bool
Category string
Classify bool
ClonePool string
Code int
Compress bool
Content string
CookieHash bool
CookieInsert bool
CookiePassive bool
CookieRewrite bool
Decompress bool
Defer bool
DestinationAddress bool
Disable bool
Domain string
Enable bool
Expiry string
ExpirySecs int
Expression string
Extension string
Facility string
Forward bool

This action will affect forwarding.

FromProfile string
Hash bool
Host string
Http bool
HttpBasicAuth bool
HttpCookie bool
HttpHeader bool
HttpHost bool
HttpReferer bool
HttpReply bool
HttpSetCookie bool
HttpUri bool
Ifile string
Insert bool
InternalVirtual string
IpAddress string
Key string
L7dos bool
Length int
Location string
Log bool
LtmPolicy bool
Member string
Message string
Netmask string
Nexthop string
Node string
Offset int
Path string
Pem bool
Persist bool
Pin bool
Policy string
Pool string

This action will direct the stream to this pool.

Port int
Priority string
Profile string
Protocol string
QueryString string
Rateclass string
Redirect bool
Remove bool
Replace bool
Request bool
RequestAdapt bool
Reset bool
Response bool
ResponseAdapt bool
Scheme string
Script string
Select bool
ServerSsl bool
SetVariable bool
Snat string
Snatpool string
SourceAddress bool
SslClientHello bool
SslServerHandshake bool
SslServerHello bool
SslSessionId bool
Status int
Tcl bool
TcpNagle bool
Text string
Timeout int
TmName string

If Rule is used then you need to provide the tm_name it can be any value

Uie bool
Universal bool
Value string
Virtual string
Vlan string
VlanId int
Wam bool
Write bool
appService string
application string
asm boolean
avr boolean
cache boolean
carp boolean
category string
classify boolean
clonePool string
code number
compress boolean
content string
cookieHash boolean
cookieInsert boolean
cookiePassive boolean
cookieRewrite boolean
decompress boolean
defer boolean
destinationAddress boolean
disable boolean
domain string
enable boolean
expiry string
expirySecs number
expression string
extension string
facility string
forward boolean

This action will affect forwarding.

fromProfile string
hash boolean
host string
http boolean
httpBasicAuth boolean
httpCookie boolean
httpHeader boolean
httpHost boolean
httpReferer boolean
httpReply boolean
httpSetCookie boolean
httpUri boolean
ifile string
insert boolean
internalVirtual string
ipAddress string
key string
l7dos boolean
length number
location string
log boolean
ltmPolicy boolean
member string
message string
netmask string
nexthop string
node string
offset number
path string
pem boolean
persist boolean
pin boolean
policy string
pool string

This action will direct the stream to this pool.

port number
priority string
profile string
protocol string
queryString string
rateclass string
redirect boolean
remove boolean
replace boolean
request boolean
requestAdapt boolean
reset boolean
response boolean
responseAdapt boolean
scheme string
script string
select boolean
serverSsl boolean
setVariable boolean
snat string
snatpool string
sourceAddress boolean
sslClientHello boolean
sslServerHandshake boolean
sslServerHello boolean
sslSessionId boolean
status number
tcl boolean
tcpNagle boolean
text string
timeout number
tmName string

If Rule is used then you need to provide the tm_name it can be any value

uie boolean
universal boolean
value string
virtual string
vlan string
vlanId number
wam boolean
write boolean
app_service str
application str
asm bool
avr bool
cache bool
carp bool
category str
classify bool
clonePool str
code float
compress bool
content str
cookieHash bool
cookieInsert bool
cookiePassive bool
cookieRewrite bool
decompress bool
defer bool
destinationAddress bool
disable bool
domain str
enable bool
expiry str
expirySecs float
expression str
extension str
facility str
forward bool

This action will affect forwarding.

fromProfile str
hash bool
host str
http bool
httpBasicAuth bool
httpCookie bool
httpHeader bool
httpHost bool
httpReferer bool
httpReply bool
httpSetCookie bool
httpUri bool
ifile str
insert bool
internalVirtual str
ipAddress str
key str
l7dos bool
length float
location str
log bool
ltmPolicy bool
member str
message str
netmask str
nexthop str
node str
offset float
path str
pem bool
persist bool
pin bool
policy str
pool str

This action will direct the stream to this pool.

port float
priority str
profile str
protocol str
queryString str
rateclass str
redirect bool
remove bool
replace bool
request bool
requestAdapt bool
reset bool
response bool
responseAdapt bool
scheme str
script str
select bool
serverSsl bool
setVariable bool
snat str
snatpool str
sourceAddress bool
sslClientHello bool
sslServerHandshake bool
sslServerHello bool
sslSessionId bool
status float
tcl bool
tcpNagle bool
text str
timeout float
tmName str

If Rule is used then you need to provide the tm_name it can be any value

uie bool
universal bool
value str
virtual str
vlan str
vlanId float
wam bool
write bool

PolicyRuleCondition

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Address bool
All bool
AppService string
BrowserType bool
BrowserVersion bool
CaseInsensitive bool
CaseSensitive bool
Cipher bool
CipherBits bool
ClientSsl bool
Code bool
CommonName bool
Contains bool
Continent bool
CountryCode bool
CountryName bool
CpuUsage bool
DeviceMake bool
DeviceModel bool
Domain bool
EndsWith bool
Equals bool
Expiry bool
Extension bool
External bool
Geoip bool
Greater bool
GreaterOrEqual bool
Host bool
HttpBasicAuth bool
HttpCookie bool
HttpHeader bool
HttpHost bool
HttpMethod bool
HttpReferer bool
HttpSetCookie bool
HttpStatus bool
HttpUri bool
HttpUserAgent bool
HttpVersion bool
Index int
Internal bool
Isp bool
Last15secs bool
Last1min bool
Last5mins bool
Less bool
LessOrEqual bool
Local bool
Major bool
Matches bool
Minor bool
Missing bool
Mss bool
Not bool
Org bool
Password bool
Path bool
PathSegment bool
Port bool
Present bool
Protocol bool
QueryParameter bool
QueryString bool
RegionCode bool
RegionName bool
Remote bool
Request bool
Response bool
RouteDomain bool
Rtt bool
Scheme bool
ServerName bool
SslCert bool
SslClientHello bool
SslExtension bool
SslServerHandshake bool
SslServerHello bool
StartsWith bool
Tcp bool
Text bool
TmName string

If Rule is used then you need to provide the tm_name it can be any value

UnnamedQueryParameter bool
UserAgentToken bool
Username bool
Value bool
Values List<string>
Version bool
Vlan bool
VlanId bool
Address bool
All bool
AppService string
BrowserType bool
BrowserVersion bool
CaseInsensitive bool
CaseSensitive bool
Cipher bool
CipherBits bool
ClientSsl bool
Code bool
CommonName bool
Contains bool
Continent bool
CountryCode bool
CountryName bool
CpuUsage bool
DeviceMake bool
DeviceModel bool
Domain bool
EndsWith bool
Equals bool
Expiry bool
Extension bool
External bool
Geoip bool
Greater bool
GreaterOrEqual bool
Host bool
HttpBasicAuth bool
HttpCookie bool
HttpHeader bool
HttpHost bool
HttpMethod bool
HttpReferer bool
HttpSetCookie bool
HttpStatus bool
HttpUri bool
HttpUserAgent bool
HttpVersion bool
Index int
Internal bool
Isp bool
Last15secs bool
Last1min bool
Last5mins bool
Less bool
LessOrEqual bool
Local bool
Major bool
Matches bool
Minor bool
Missing bool
Mss bool
Not bool
Org bool
Password bool
Path bool
PathSegment bool
Port bool
Present bool
Protocol bool
QueryParameter bool
QueryString bool
RegionCode bool
RegionName bool
Remote bool
Request bool
Response bool
RouteDomain bool
Rtt bool
Scheme bool
ServerName bool
SslCert bool
SslClientHello bool
SslExtension bool
SslServerHandshake bool
SslServerHello bool
StartsWith bool
Tcp bool
Text bool
TmName string

If Rule is used then you need to provide the tm_name it can be any value

UnnamedQueryParameter bool
UserAgentToken bool
Username bool
Value bool
Values []string
Version bool
Vlan bool
VlanId bool
address boolean
all boolean
appService string
browserType boolean
browserVersion boolean
caseInsensitive boolean
caseSensitive boolean
cipher boolean
cipherBits boolean
clientSsl boolean
code boolean
commonName boolean
contains boolean
continent boolean
countryCode boolean
countryName boolean
cpuUsage boolean
deviceMake boolean
deviceModel boolean
domain boolean
endsWith boolean
equals boolean
expiry boolean
extension boolean
external boolean
geoip boolean
greater boolean
greaterOrEqual boolean
host boolean
httpBasicAuth boolean
httpCookie boolean
httpHeader boolean
httpHost boolean
httpMethod boolean
httpReferer boolean
httpSetCookie boolean
httpStatus boolean
httpUri boolean
httpUserAgent boolean
httpVersion boolean
index number
internal boolean
isp boolean
last15secs boolean
last1min boolean
last5mins boolean
less boolean
lessOrEqual boolean
local boolean
major boolean
matches boolean
minor boolean
missing boolean
mss boolean
not boolean
org boolean
password boolean
path boolean
pathSegment boolean
port boolean
present boolean
protocol boolean
queryParameter boolean
queryString boolean
regionCode boolean
regionName boolean
remote boolean
request boolean
response boolean
routeDomain boolean
rtt boolean
scheme boolean
serverName boolean
sslCert boolean
sslClientHello boolean
sslExtension boolean
sslServerHandshake boolean
sslServerHello boolean
startsWith boolean
tcp boolean
text boolean
tmName string

If Rule is used then you need to provide the tm_name it can be any value

unnamedQueryParameter boolean
userAgentToken boolean
username boolean
value boolean
values string[]
version boolean
vlan boolean
vlanId boolean
address bool
all bool
app_service str
browserType bool
browserVersion bool
caseInsensitive bool
caseSensitive bool
cipher bool
cipherBits bool
clientSsl bool
code bool
commonName bool
contains bool
continent bool
countryCode bool
countryName bool
cpuUsage bool
deviceMake bool
deviceModel bool
domain bool
endsWith bool
equals bool
expiry bool
extension bool
external bool
geoip bool
greater bool
greaterOrEqual bool
host bool
httpBasicAuth bool
httpCookie bool
httpHeader bool
httpHost bool
httpMethod bool
httpReferer bool
httpSetCookie bool
httpStatus bool
httpUri bool
httpUserAgent bool
httpVersion bool
index float
internal bool
isp bool
last15secs bool
last1min bool
last5mins bool
less bool
lessOrEqual bool
local bool
major bool
matches bool
minor bool
missing bool
mss bool
not bool
org bool
password bool
path bool
pathSegment bool
port bool
present bool
protocol bool
queryParameter bool
queryString bool
regionCode bool
regionName bool
remote bool
request bool
response bool
routeDomain bool
rtt bool
scheme bool
server_name bool
sslCert bool
sslClientHello bool
sslExtension bool
sslServerHandshake bool
sslServerHello bool
startsWith bool
tcp bool
text bool
tmName str

If Rule is used then you need to provide the tm_name it can be any value

unnamedQueryParameter bool
userAgentToken bool
username bool
value bool
values List[str]
version bool
vlan bool
vlanId bool

Package Details

Repository
https://github.com/pulumi/pulumi-f5bigip
License
Apache-2.0
Notes
This Pulumi package is based on the bigip Terraform Provider.