System::ConfigSync::delete_single_configuration_file

Introduced : BIG-IP_v12.1.0
Deletes the specified configuration from the SCF directory. If the specified file doesn&apost exist, an exception will be raised. The specified configuration should not contain any path information since it is restricted to be in the SCF directory. If there is a default TAR file archive in the same directory of the form [filepath].tar, it will be deleted as well. If a non-default TAR filename was specified when the SCF file was created, it can be deleted separately with this same method. NOTE: File names containing the following characters will be considered invalid: ` ~ / \ : ; * ? ” < > | &

Prototype

 delete_single_configuration_file(
    in String filename
);

Parameters

Parameter Type Description
filename String The SCF file to be deleted. length limit: 255.

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 :: System :: ConfigSync

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.