System::Session::ReturnedPath

Introduced : BIG-IP_v11.0.0
Specification for the path information included with object names. There are no methods to retrieve the folder that hold a specific object. To determine that, when querying object names, the full folder path can be prepended to the name, e.g., /george/server/virtual/repository-a. However, that is not always wanted. The returned object path could include the full path, a path relative to the active folder, or even just the bare path-less object name. This enumeration controls that option.

Members

Member

Value

Description

PATH_UNKNOWN

0

Invalid or unrecognized enumeration value.

PATH_FULL

1

Return the full object path.

PATH_RELATIVE

2

Return the path relative to the active folder. If the object is not in a folder under the active folder, the full object path is returned. For example, if the active folder is /george/server, querying the object /george/server/virtual/repository-a returns virtual/repository-a. If the active folder is /herman/server, querying that object returns /george/server/virtual/repository-a.

PATH_BARE

3

Return no path information in the object names. In this case, the folder information is completely eliminated from the object name. For example, querying the object /george/server/virtual/repository-a returns “repository-a”. This option should be used with care, but has been added for strict backward compatibility with the pre-folder releases.

See Also

iControl ::
iControl :: System :: Session

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.