ABOUT DEVCENTRAL

DevCentral News Technical Forum Technical Articles Technical CrowdSRC Community Guidelines DevCentral EULA Get a Developer Lab License Become a DevCentral MVP

RESOURCES

Product Documentation White Papers Glossary Customer Stories Webinars Free Online Courses F5 Certification LearnF5 Training

SUPPORT

Manage Subscriptions Professional Services Professional Services Create a Service Request Software Downloads Support Portal

PARTNERS

Find a Reseller Partner Technology Alliances Become an F5 Partner Login to Partner Central

---

©2024 F5, Inc. All rights reserved.

This cookbook lists selected ready-to-use iControl REST curl commands for LTM policy related resources (the tmsh command xxx ltm policy). Each recipe consists of the curl command and it's tmsh equivallent.

See also

• iControl REST Cookbook - Virtual Server (ltm virtual) - for the list of curl options.
• K33749970: Managing local traffic policies on the BIG-IP system using the tmsh utility (12.1.0 and later) - for tmsh commands for LTM policies.

Get a list of policies

The iControl REST call returns both drafts and published policies: In the /Common partition, they are located under /Common/Drafts and /Common respectively. On the other hand, the tmsh equivalent command outputs only the ones under the current folder.

list ltm policy

\ncurl -sku admin:admin https://<host>/mgmt/tm/ltm/policy

To get a specific published policy, just add its name to the URI.

list ltm policy <PublishedPolicy>

\ncurl -sku admin:admin https://<host>/mgmt/tm/ltm/policy/<PublishedPolicy>

To get a specific draft policy, add the full path to the policy. Note that '~' (tilde) is used instead of '/' (slash) for the path delimiter.

list ltm policy Drafts/<TestPolicy>

\ncurl -sku admin:admin https://<host>/mgmt/tm/ltm/policy/~Common~Drafts~<TestPolicy>

The rules in a policy is stored in the subcollections, hence the above calls return only links to the rules. To get the contents of the rules, use the expandSubcollections=true query option.

\ncurl -sku admin:admin https://<host>/mgmt/tm/ltm/policy/~Common~Drafts~<TestPolicy>?expandSubcollections=true

Get the rules of a policy

The following call will get all the rules in the draft policy.

list ltm policy Drafts/<TestPolicy> rules

\ncurl -sku admin:admin https://<host>/mgmt/tm/ltm/policy/~Common~Drafts~<TestPolicy>/rules?expandSubcollections=true

For obtaining the particular one, run this.

\ncurl -sku admin:admin https://<host>/mgmt/tm/ltm/policy/~Common~Drafts~<TestPolicy>/rules/<SampleRule>?expandSubcollections=true

Create a draft policy

The following call creates a new draft policy with the 'first-match' strategy. Note that the path to the policy inside the post data uses '/'.

create ltm policy Drafts/<TestPolicy> strategy first-match

\ncurl -sku admin:admin https://<host>/mgmt/tm/ltm/policy \\\n  -X POST -H \"Content-type:application/json\" \\\n  -d '{\"name\":\"/Common/Drafts/<TestPolicy>\", \"strategy\":\"first-match\"}'

To create (copy) a draft policy from the existing draft policy, run this. Note that the path to the existing draft policy (?options argument) uses '/'.

create ltm policy /Common/Drafts/<TestPolicy2> copy-from /Common/Drafts/<TestPolicy>

\ncurl -sku admin:admin https://<host>/mgmt/tm/ltm/policy?options=copy-from,/Common/Drafts/<TestPolicy> \\\n  -X POST -H \"Content-type:application/json\" \\\n  -d '{\"name\":\"/Common/Drafts/<TestPolicy2>\"}'

Adding a rule to the draft policy

modify ltm policy Drafts/<TestPolicy> rules add { <SampleRule> { description sat1 } }

\ncurl -sku admin:admin https://<host>/mgmt/tm/ltm/policy/~Common~Drafts~<TestPolicy>/rules \\\n  -X POST -H \"Content-type:application/json\" \\\n  -d '{\"name\":\"<SampleRule>\", \"description\":\"sat1\" }'

Modifying the rule

modify ltm policy Drafts/<TestPolicy> rules modify { <SampleRule> { description \"Hello World\"} }

\ncurl -sku admin:admin https://<host>/mgmt/tm/ltm/policy/~Common~Drafts~<TestPolicy>/rules/<SampleRule> \\\n  -X PATCH -H \"Content-type:application/json\" \\\n  -d '{\"description\":\"Hello World\" }'

Deleting the rule from the draft policy

modify ltm policy Drafts/<TestPolicy> rules delete { <SampleRule> }

\ncurl -sku admin:admin https://<host>/mgmt/tm/ltm/policy/~Common~Drafts~<TestPolicy>/rules/<SampleRule> -X DELETE

Deleging the draft policy

delete ltm policy Drafts/<TestPolicy>

\ncurl -sku admin:admin https://<host>/mgmt/tm/ltm/policy/~Common~Drafts~<TestPolicy> -X DELETE

Publishing the draft policy

publish ltm policy Drafts/<TestPolicy>

\ncurl -sku admin:admin https://<host>/mgmt/tm/ltm/policy \\\n  -X POST -H \"Content-type: application/json\" \\\n  -d '{\"command\":\"publish\", \"name\":\"Drafts/<TestPolicy>\"}'

Creating the draft policy from a published policy

modify ltm policy <PublishedPolicy> create-draft

\ncurl -sku admin:admin https://<host>/mgmt/tm/ltm/policy/<PublishedPolicy>?options=create-draft \\\n  -X PATCH -H \"Content-type: application/json\" \\\n  -d '{}'

Modifying a virtual

To replace the policies attached to a virtual with a specific published policy, run this

modify ltm virtual <vs> policies replace-all-with { <PublishedPolicy> }

\ncurl -sku admin:admin https://<host>/mgmt/tm/ltm/virtual/<vs>/policies \\\n  -H \"Content-type: application/json\" -X POST \\\n  -d '{\"name\":<PublishedPolicy>}'

To remove the policies from a virtual, run this

\ncurl -sku admin:admin https://<host>/mgmt/tm/ltm/virtual/<vs> \\\n  -H \"Content-type: application/json\" -X PATCH \\\n  -d '{\"policiesReference\":{ \"items\":[] } }'

This cookbook lists selected ready-to-use iControl REST curl commands for LTM policy related resources (the tmsh command 

xxx ltm policy

See also

• iControl REST Cookbook - Virtual Server (ltm virtual) - for the list of curl options.
• K33749970: Managing local traffic policies on the BIG-IP system using the tmsh utility (12.1.0 and later) - for tmsh commands for LTM policies.

Get a list of policies

The iControl REST call returns both drafts and published policies: In the /Common partition, they are located under

/Common/Drafts

/Common

list ltm policy

\ncurl -sku admin:admin https://<host>/mgmt/tm/ltm/policy

To get a specific published policy, just add its name to the URI.

list ltm policy <PublishedPolicy>

\ncurl -sku admin:admin https://<host>/mgmt/tm/ltm/policy/<PublishedPolicy>

To get a specific draft policy, add the full path to the policy. Note that '~' (tilde) is used instead of '/' (slash) for the path delimiter.

list ltm policy Drafts/<TestPolicy>

\ncurl -sku admin:admin https://<host>/mgmt/tm/ltm/policy/~Common~Drafts~<TestPolicy>

The rules in a policy is stored in the subcollections, hence the above calls return only links to the rules. To get the contents of the rules, use the

expandSubcollections=true

\ncurl -sku admin:admin https://<host>/mgmt/tm/ltm/policy/~Common~Drafts~<TestPolicy>?expandSubcollections=true

Get the rules of a policy

The following call will get all the rules in the draft policy.

list ltm policy Drafts/<TestPolicy> rules

\ncurl -sku admin:admin https://<host>/mgmt/tm/ltm/policy/~Common~Drafts~<TestPolicy>/rules?expandSubcollections=true

For obtaining the particular one, run this.

\ncurl -sku admin:admin https://<host>/mgmt/tm/ltm/policy/~Common~Drafts~<TestPolicy>/rules/<SampleRule>?expandSubcollections=true

Create a draft policy

The following call creates a new draft policy with the 'first-match' strategy. Note that the path to the policy inside the post data uses '/'.

create ltm policy Drafts/<TestPolicy> strategy first-match

\ncurl -sku admin:admin https://<host>/mgmt/tm/ltm/policy \\\n  -X POST -H \"Content-type:application/json\" \\\n  -d '{\"name\":\"/Common/Drafts/<TestPolicy>\", \"strategy\":\"first-match\"}'

To create (copy) a draft policy from the existing draft policy, run this. Note that the path to the existing draft policy (

?options

create ltm policy /Common/Drafts/<TestPolicy2> copy-from /Common/Drafts/<TestPolicy>

\ncurl -sku admin:admin https://<host>/mgmt/tm/ltm/policy?options=copy-from,/Common/Drafts/<TestPolicy> \\\n  -X POST -H \"Content-type:application/json\" \\\n  -d '{\"name\":\"/Common/Drafts/<TestPolicy2>\"}'

Adding a rule to the draft policy

modify ltm policy Drafts/<TestPolicy> rules add { <SampleRule> { description sat1 } }

\ncurl -sku admin:admin https://<host>/mgmt/tm/ltm/policy/~Common~Drafts~<TestPolicy>/rules \\\n  -X POST -H \"Content-type:application/json\" \\\n  -d '{\"name\":\"<SampleRule>\", \"description\":\"sat1\" }'

Modifying the rule

modify ltm policy Drafts/<TestPolicy> rules modify { <SampleRule> { description \"Hello World\"} }

\ncurl -sku admin:admin https://<host>/mgmt/tm/ltm/policy/~Common~Drafts~<TestPolicy>/rules/<SampleRule> \\\n  -X PATCH -H \"Content-type:application/json\" \\\n  -d '{\"description\":\"Hello World\" }'

Deleting the rule from the draft policy

modify ltm policy Drafts/<TestPolicy> rules delete { <SampleRule> }

\ncurl -sku admin:admin https://<host>/mgmt/tm/ltm/policy/~Common~Drafts~<TestPolicy>/rules/<SampleRule> -X DELETE

Deleging the draft policy

delete ltm policy Drafts/<TestPolicy>

\ncurl -sku admin:admin https://<host>/mgmt/tm/ltm/policy/~Common~Drafts~<TestPolicy> -X DELETE

Publishing the draft policy

publish ltm policy Drafts/<TestPolicy>

\ncurl -sku admin:admin https://<host>/mgmt/tm/ltm/policy \\\n  -X POST -H \"Content-type: application/json\" \\\n  -d '{\"command\":\"publish\", \"name\":\"Drafts/<TestPolicy>\"}'

Creating the draft policy from a published policy

modify ltm policy <PublishedPolicy> create-draft

\ncurl -sku admin:admin https://<host>/mgmt/tm/ltm/policy/<PublishedPolicy>?options=create-draft \\\n  -X PATCH -H \"Content-type: application/json\" \\\n  -d '{}'

Modifying a virtual

To replace the policies attached to a virtual with a specific published policy, run this

modify ltm virtual <vs> policies replace-all-with { <PublishedPolicy> }

\ncurl -sku admin:admin https://<host>/mgmt/tm/ltm/virtual/<vs>/policies \\\n  -H \"Content-type: application/json\" -X POST \\\n  -d '{\"name\":<PublishedPolicy>}'

To remove the policies from a virtual, run this

\ncurl -sku admin:admin https://<host>/mgmt/tm/ltm/virtual/<vs> \\\n  -H \"Content-type: application/json\" -X PATCH \\\n  -d '{\"policiesReference\":{ \"items\":[] } }'

It doesn't work for me the API for replace the policies attached to a virtual server,

curl -sku admin:default https://192.168.1.74/mgmt/tm/ltm/virtual/http_policy/policies \\

 -H \"Content-type: application/json\" -X POST \\

 -d '{\"name\":policy_sorrypage}' | jq . -M

{

 \"code\": 400,

 \"message\": \"Found invalid JSON body in the request.\",

 \"errorStack\": [],

 \"apiError\": 1

}

where is the error?

Tks

It doesn't work for me the API for replace the policies attached to a virtual server,

curl -sku admin:default https://192.168.1.74/mgmt/tm/ltm/virtual/http_policy/policies \\

 -H \"Content-type: application/json\" -X POST \\

 -d '{\"name\":policy_sorrypage}' | jq . -M

{

 \"code\": 400,

 \"message\": \"Found invalid JSON body in the request.\",

 \"errorStack\": [],

 \"apiError\": 1

}

where is the error?

Tks