0.9.1
  • iApps Home
  • iControlREST Home
  • iControl (SOAP) Home
  • iRules Home
  • iRulesLX Home
  • TMSH Home
  • Clouddocs > > GlobalLB::Link::set_description

Version notice:

GlobalLB::Link::set_description¶

Introduced : BIG-IP_v11.0.0
Sets the description for a set of links. This is an arbitrary field which can be used for any purpose.

Prototype¶

 set_description(
    in String [] links,
    in String [] descriptions
);

Parameters¶

Parameter Type Description
links String [] Names of the links to modify.
descriptions String [] Descriptions for each specified link.

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 :: GlobalLB :: Link

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.