Skip to main content

Get virtual server pseudo clients filtered by permission​

Returns the list of virtual server pseudo clients that the specified permission category grants access to. Optionally filters by virtualization vendor type and excludes admin clients.

Query Parameters
  • permissionId int32 required

    ID of the permission category used to filter accessible virtual server pseudo clients

  • vendor string

    Possible values: [NONE, VMW, MICROSOFT, XEN_SERVER, AMAZON, AZURE, REDHAT, AZURE_V2, SCVMM, NUTANIX, ORACLE_VM, DOCKER, OPENSTACK, ORACLE_CLOUD, FUSIONCOMPUTE, VCLOUD, GOOGLE_CLOUD, AZURE_STACK, ALIBABA_CLOUD, ORACLE_CLOUD_INFRASTRUCTURE, KUBERNETES, REDHAT_OPENSHIFT, MONGODB_ATLAS, PROXMOX, KUBERNETES_AKS, AZURE_STACK_HCI, KUBERNETES_EKS, MORPHEUS, KUBERNETES_GKE, KUBERNETES_OKE, NUTANIX_PRISM_CENTRAL, APACHE_CLOUDSTACK, VMWARE_CLOUD_FOUNDATION, NEXAVM, INCUS]

    Virtualization vendor type to filter by. Defaults to NONE (all vendors).

  • filterAdminClient boolean

    When true, excludes admin pseudo clients from the result set. Defaults to false.

Responses

OK

Schema
  • vsaVirtualClientList object[]

    List of virtual server pseudo client entries

  • client object

    The pseudo-client entity

  • clientId int32

    Unique ID of the client

  • clientName string

    Display name of the client

  • hostName string

    Network hostname of the client machine

  • displayName string

    Human-friendly display name shown in the UI

  • instance object

    The VSA instance running on the pseudo-client

  • clientId int32

    ID of the parent client that owns this instance

  • clientName string

    Name of the parent client

  • applicationId int32

    iDataAgent application type ID

  • instanceId int32

    Unique ID of the instance

  • instanceName string

    Name of the instance

  • status int32

    Status code of the pseudo client

  • isTenantClient int32

    Non-zero if this pseudo client belongs to a tenant company

  • adminInstanceId int32

    ID of the admin instance associated with this pseudo client

Loading...