Child pages
    • Citrix NetScaler VPX Load Balancer
    Skip to end of metadata
    Go to start of metadata

    The Citrix NetScaler VPX pattern builds the Discovery Load Balancer model based on additional details obtained via SNMP for the configured Virtual Servers, Services and Service Groups from the NetScaler VPX load balancer. Any configuration no longer reported is removed from the model.

    Load Balancer Model

    Citrix NetScaler VPX uses the following conceptual model:

    • Virtual Server (n) - (n) Service Group (n) - (n) Server
    • Virtual Server (n) - (n) Service (n) - (1) Server

    A Virtual Server is modeled as a Load Balancer Service.

    A Service and a Server are modeled as a Load Balancer Pool and a Load Balancer Member.

    A Service Group and Servers are modeled as a Load Balancer Pool  and Load Balancer Members.

    For Citrix NetScaler hardware-based appliances that can run virtual instance pattern creates corresponding Virtual Machines and links these VMs to virtual Network Devices:

    Supported virtual server types

    • unknown
    • loadbalancing
    • loadbalancinggroup
    • sslvpn
    • contentswitching
    • cacheredirection

    Supported virtual server states

    • down

    • unknown

    • busy

    • outOfService

    • transitionToOutOfService

    • up

    • transitionToOutOfServiceDown

    Supported protocol types

    • http

    • ftp

    • tcp

    • udp

    • sslBridge

    • monitor

    • monitorUdp

    • nntp

    • httpserver

    • httpclient

    • rpcserver

    • rpcclient

    • nat

    • any

    • ssl

    • dns

    • adns

    • snmp

    • ha

    • monitorPing

    • sslOtherTcp

    • aaa

    • secureMonitor

    • sslvpnUdp

    • rip

    • dnsClient

    • rpcServer

    • rpcClient

    • dhcrpa

    • sipudp

    • dnstcp

    • adnstcp

    • rtsp

    • push

    • sslPush

    • dhcpClient

    • radius

    • rdp

    • mysql

    • mssql

    • diameter

    • sslDiameter

    • tftp

    • serviceUnknown

    Supported device HA mode

    • Standalone

    • Primary

    • Secondary

    • Unknown

    Supported device HA state

    • Unknown

    • Init

    • Down

    • Up

    • PartialFail

    • MonitorFail

    • MonitorOk

    • CompleteFail

    • Dumb

    • Disabled

    • PartialFailSSL

    • RouteMonitorFail

    Modeled Load Balancer Components

    Load Balancer Instance

    The pattern creates a Load Balancer Instance with the following attributes:

    AttributesValue
    keyA hash of the device key and load balancer type.
    typeA load balancer type.
    nameA %LB_TYPE% on %device.name%.
    versionA version of the device OS.
    failover_typeA failover type used on the device.
    failover_stateA failover state reported by the device.
    __failover_groupNo sample.
    __failover_paired_ipaddrNo sample.

    The pattern models a network service relationship between the device and the Load Balancer Instance.

    Load Balancer Service

    The pattern creates a Load Balancer Service with the following attributes:

    AttributesValue
    key

    A hash of the instance key, virtual server name, ip address, and port.

    nameA virtual server name.
    ip_addrA virtual server IP address.
    portA virtual server port.
    typeA virtual server type.
    protocolA virtual server protocol type.
    stateA virtual server state.
    dns_namesA dns name of a virtual server IP address.
    _config_hashContains a hash of the virtual server name, IP address, port, type,protocol, and state.

    The pattern models a containment relationship between the Load Balancer Instance and a Load Balancer Service.

    The pattern also models a containment relationship between the Load Balancer Service and a Load Balancer Pool.

    Load Balancer Pool

    The pattern creates a Load Balancer Pool with the following attributes:

    AttributesValue
    keyA hash of the instance key and pool name.
    nameA pool name.
    protocol

    A protocol used.

    _config_hashContains a hash of the pool name, and protocol.

    The pattern models a containment relationship between the Load Balancer Instance and a Load Balancer Pool.

    Load Balancer Member

    The pattern creates a Load Balancer Member  for every server and populates the following attributes:

    AttributesValue
    key

    A hash of the instance key, IP address and port of the real server.

    ip_addrA server IP address.
    portA server port.
    nameA pair of server IP address and port.
    _config_hashContains a hash of the server ip address, port, and type.

    The pattern models a containment relationship between the Load Balancer Pool and a Load Balancer Member.


    Virtual Machine

    The pattern creates a Virtual Machine for every virtual instances and populates the following attributes:

    AttributesValue
    key

    A hash of the instance uuid, physical device key.

    nameVirtual Machine name
    short_nameVirtual Machine short name
    type"Citrix XenServer"
    vm_type"XenServer"
    vm_nameVirtual Load Balancer name
    vm_uuidVirtual Machine UUID
    versionXenServer version
    vm_guest_osVirtual Load Balancer OS
    product_versionXenServer product version
    editionXenServer edition
    buidXenServer build
    stateVirtual Machine state

    The pattern models a relationships between the Virtual Machine and physical, virtual Load Balancer.