LocalLB::Monitor::set_template_user_defined_string_property

Introduced : BIG-IP_v9.0
Sets the user-defined string property values of the specified monitor templates. The user-defined string property is an arbitrary name/value pair used as configuration information for the monitor. Only certain monitors accept such user-defined properties and the meaning of these name/value pairs is dependent on the specific monitor.

Prototype

 set_template_user_defined_string_property(
    in String [] template_names,
    in LocalLB__Monitor__UserDefinedStringValue [] values
);

Parameters

Parameter Type Description
template_names String [] The names of the monitor templates.
values UserDefinedStringValue [] The string property name/value pairs to set for the monitor templates.

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

iControl ::
iControl :: LocalLB :: Monitor

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


Copyright © 1996-2012, F5 Networks, Inc. All rights reserved.

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.