Type alias MsgVpnBridgeRemoteMsgVpn

MsgVpnBridgeRemoteMsgVpn: {
    bridgeName?: string;
    bridgeVirtualRouter?: MsgVpnBridgeRemoteMsgVpn.bridgeVirtualRouter;
    clientUsername?: string;
    compressedDataEnabled?: boolean;
    connectOrder?: number;
    egressFlowWindowSize?: number;
    enabled?: boolean;
    msgVpnName?: string;
    password?: string;
    queueBinding?: string;
    remoteMsgVpnInterface?: string;
    remoteMsgVpnLocation?: string;
    remoteMsgVpnName?: string;
    tlsEnabled?: boolean;
    unidirectionalClientProfile?: string;
}

Type declaration

  • Optional bridgeName?: string

    The name of the Bridge.

  • Optional bridgeVirtualRouter?: MsgVpnBridgeRemoteMsgVpn.bridgeVirtualRouter

    The virtual router of the Bridge. The allowed values and their meaning are:

    "primary" - The Bridge is used for the primary virtual router.
"backup" - The Bridge is used for the backup virtual router.
"auto" - The Bridge is automatically assigned a virtual router at creation, depending on the broker's active-standby role.
  • Optional clientUsername?: string

    The Client Username the Bridge uses to login to the remote Message VPN. This per remote Message VPN value overrides the value provided for the Bridge overall. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

  • Optional compressedDataEnabled?: boolean

    Enable or disable data compression for the remote Message VPN connection. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

  • Optional connectOrder?: number

    The preference given to incoming connections from remote Message VPN hosts, from 1 (highest priority) to 4 (lowest priority). Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 4.

  • Optional egressFlowWindowSize?: number

    The number of outstanding guaranteed messages that can be transmitted over the remote Message VPN connection before an acknowledgement is received. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is 255.

  • Optional enabled?: boolean

    Enable or disable the remote Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

  • Optional msgVpnName?: string

    The name of the Message VPN.

  • Optional password?: string

    The password for the Client Username. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

  • Optional queueBinding?: string

    The queue binding of the Bridge in the remote Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "".

  • Optional remoteMsgVpnInterface?: string

    The physical interface on the local Message VPN host for connecting to the remote Message VPN. By default, an interface is chosen automatically (recommended), but if specified, remoteMsgVpnLocation must not be a virtual router name.

  • Optional remoteMsgVpnLocation?: string

    The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with "v:").

  • Optional remoteMsgVpnName?: string

    The name of the remote Message VPN.

  • Optional tlsEnabled?: boolean

    Enable or disable encryption (TLS) for the remote Message VPN connection. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is false.

  • Optional unidirectionalClientProfile?: string

    The Client Profile for the unidirectional Bridge of the remote Message VPN. The Client Profile must exist in the local Message VPN, and it is used only for the TCP parameters. Note that the default client profile has a TCP maximum window size of 2MB. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is "#client-profile".

Settings

Member Visibility

Theme