ARX::VirtualService

Introduced : ARX V5.02.000
The VirtualService Interface lets applications retrieve ARX virtual service information. CLI References: Global Server, Front-End Services.

Methods

Method Description Introduced
get_cifs_open_files Returns a list of ARX virtual service CIFS open files. CLI References: show cifs-service open-files. ARX V6.02.000
get_cifs_user_sessions Returns a list of ARX virtual service CIFS sessions. CLI References: show cifs-service user-sessions. ARX V6.02.000
get_configuration Returns a list of ARX virtual service configurations. CLI References: Global Server, Front-End Services. ARX V6.02.000
get_definition Returns the details of the specified virtual services. ARX V5.02.000
get_definition2 Returns the details of the specified virtual services. ARX V6.00.000
get_list Returns the list of virtual service names. CLI References: show global server. ARX V5.02.000
get_statistics Returns a list of ARX virtual service statistics. CLI References: show statistics global serve. ARX V6.02.000
get_stats Returns the statistics of the specified virtual services. ARX V5.02.000
get_status Returns a list of ARX virtual service statuses. CLI References: show global server, show cifs-service, show nfs-service. ARX V6.02.000

Structures

Structure

Description

CifsServiceConfiguration

A structure that contains the CIFS configurations of a virtual service. CLI References: Global Server, Front-End Services, cifs (gbl).

Configuration

A structure that contains the configurations of a virtual service. CLI References: Global Server, Front-End Services.

KerberosCredentialsConfiguration

A structure that contains the Kerberos credentials configurations of a virtual service.

NfsOfflineBehaviorConfiguration

A structure that contains the NFS configurations of a virtual service. CLI References: offline-behavior (gbl-nfs).

NfsServiceConfiguration

A structure that contains the NFS configurations of a virtual service. CLI References: Front-End Services, nfs (gbl).

OpenFile

A structure that contains a file that a CIFS client is holding open. CLI References: show cifs-service open-files.

OpenFiles

A structure that defines a collection of files that CIFS clients are holding open. CLI References: show cifs-service open-files.

ServerConfiguration

A structure that contains the virtual server configurations of a virtual service. CLI References: virtual server (gbl-gs).

SpnStatus

A structure that contains the status of a virtual service&aposs Active-Directory alias. CLI References: show global server.

Statistics

A structure that defines thevirtual service&aposs statistics. CLI References: show statistics global serve.

Status

A structure that contains the status of a virtual service. CLI References: show global server, show cifs-service, show nfs-service.

UserSession

A structure that contains a client connection to a CIFS service. CLI References: show cifs-service user-sessions.

UserSessions

A structure that contains a collection of client connections to a CIFS service. CLI References: show cifs-service user-sessions.


Enumerations

Enumeration Description
AdAliasStateType Enumeration of state of the active directory alias. CLI References: show global server.
DelegationType Enumeration of ARX CIFS virtual service delegation types.
SmbSigningType Enumeration of types of SMB signings. CLI References: signatures (gbl-cifs).
StateType Enumeration of ARX virtual service states. CLI References: show virtual service.

Exceptions

Exception Description

Constants

Constant Type Value Description

Aliases

Alias Type Description
AdAliasStateTypeSequence AdAliasStateType [] A sequence of AdAliasStateType
CifsServiceConfigurationSequence CifsServiceConfiguration [] A sequence of CifsServiceConfiguration
ConfigurationSequence Configuration [] A sequence of Configuration
DelegationTypeSequence DelegationType [] A sequence of DelegationType
KerberosCredentialsConfigurationSequence KerberosCredentialsConfiguration [] A sequence of KerberosCredentialsConfiguration
NfsOfflineBehaviorConfigurationSequence NfsOfflineBehaviorConfiguration [] A sequence of NfsOfflineBehaviorConfiguration
NfsServiceConfigurationSequence NfsServiceConfiguration [] A sequence of NfsServiceConfiguration
OpenFileSequence OpenFile [] A sequence of OpenFile
OpenFilesSequence OpenFiles [] A sequence of OpenFiles
ServerConfigurationSequence ServerConfiguration [] A sequence of ServerConfiguration
SmbSigningTypeSequence SmbSigningType [] A sequence of SmbSigningType
SpnStatusSequence SpnStatus [] A sequence of SpnStatus
StateTypeSequence StateType [] A sequence of StateType
StatisticsSequence Statistics [] A sequence of Statistics
StatusSequence Status [] A sequence of Status
UserSessionSequence UserSession [] A sequence of UserSession
UserSessionsSequence UserSessions [] A sequence of UserSessions

See Also

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


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.