LTConfig::Field::set_value

Introduced : BIG-IP_v9.4.2
Sets the value for one loosely-typed configuration field instance for the specified class instance. This is for convenience, when you want to set just one value in just one class instance. Use set_values instead for greater efficiency when setting multiple field values.

Prototype

 set_value(
    in boolean create_instances_if_needed,
    in LTConfig__ClassInstanceKey class_instance_key,
    in String field_instance_name,
    in String value
);

Parameters

Parameter Type Description
create_instances_if_needed boolean Whether to create the class instances if needed.
class_instance_key ClassInstanceKey The class instance containing the field of interest.
field_instance_name String A field instance for which to set value.
value String A field instance value. The value is given as a string when using this method.

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 :: LTConfig :: Field

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.