Security::FirewallGlobalRuleList::set_fw_rule_description

Introduced : BIG-IP_v11.3.0
Sets the description for the specified firewall rules. This is an arbitrary field which can be used for any purpose.

Prototype

 set_fw_rule_description(
    in String [] rules,
    in String [] descriptions
);

Parameters

Parameter Type Description
rules String [] The firewall rules to modify.
descriptions String [] Descriptions for each specified firewall rule.

Return Type

Type Description
void  

Exceptions

Exception Description
Common::AccessDenied Raised if the client credentials are not valid.
Common::InvalidArgument Raised if one of the arguments is invalid.
Common::OperationFailed Raised if an operation error occurs.

See Also

Warning

The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.

Sample Code


The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.