Developer Documentation
ADC CLI Commands
Current Release 13.1 13.0 12.1

api-specfile

May 28, 2024
Contributed by: 
C

The following operations can be performed on “api-specfile”:

import show rm

import api specfile

Imports a spec file to the Citrix ADC, assigns it a name, and stores it in the /nsconfig/apispec/specfile folder. The folder is created if it does not exist.

Synopsis

import api specfile [-overwrite]

Arguments

name Name to assign to the imported spec file. Must begin with an ASCII alphanumeric or underscore(_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@),equals (=), and hyphen (-) characters. The following requirement applies only to the Citrix ADC CLI: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, “my file” or ‘my file’).

src URL specifying the protocol, host, and path, including file name, to the spec file to be imported. For example, http://www.example.com/spec_file. NOTE: The import fails if the object to be imported is on an HTTPS server that requires client certificate authentication for access.

overwrite Overwrite any existing schema file of the same name.

Example

import specfile my-specfile http://www.example.com/spec_file

show api specfile

Displays a list of all the imported spec file objects on the Citrix ADC.

Synopsis

show api specfile []

Arguments

name Name of the specfile object.

Output

name Name to assign to the imported spec file. Must begin with an ASCII alphanumeric or underscore(_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@),equals (=), and hyphen (-) characters. The following requirement applies only to the Citrix ADC CLI: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, “my file” or ‘my file’).

src URL specifying the protocol, host, and path, including file name, to the spec file to be imported. For example, http://www.example.com/spec_file. NOTE: The import fails if the object to be imported is on an HTTPS server that requires client certificate authentication for access.

devno count stateflag

Example

show api specfile

rm api specfile

Deletes the specified spec file.

Synopsis

rm api specfile

Arguments

name Name to assign to the imported spec file. Must begin with an ASCII alphanumeric or underscore(_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@),equals (=), and hyphen (-) characters. The following requirement applies only to the Citrix ADC CLI: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, “my file” or ‘my file’).

Example

rm api specfile

api-specfile
May 28, 2024
Contributed by: 
C
May 28, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.