Management::Partition::set_active_partition

Introduced : BIG-IP_v9.4.0
This method is deprecated; please use System::Session::set_active_folder instead. Sets the active partition for the current user. The active partition is the administrative partition where all configuration will take place until a new active partition is selected. Each user can only be in one active partition at any given time. By default, if not explicitly set, the active partition for a user will be “Common”. Note: Please note that this method is deprecated. If you set the partition to “[All]”, this maps to the System::Session interface method set_active_folder(“/”) and in this case this method automatically performs set_recursive_query_state(STATE_ENABLED) as well.

Prototype

 set_active_partition(
    in String active_partition
);

Parameters

Parameter Type Description
active_partition String The active partition to set.

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 :: Management :: Partition

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.