Variable $MsgVpnBridgeRemoteMsgVpnConst

Type declaration

• properties: {
      bridgeName: {
          description: "The name of the Bridge.";
          type: "string";
      };
      bridgeVirtualRouter: {
          type: "Enum";
      };
      clientUsername: {
          description: "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 `\"\"`.";
          type: "string";
      };
      compressedDataEnabled: {
          description: "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`.";
          type: "boolean";
      };
      connectOrder: {
          description: "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`.";
          format: "int32";
          type: "number";
      };
      egressFlowWindowSize: {
          description: "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`.";
          format: "int64";
          type: "number";
      };
      enabled: {
          description: "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`.";
          type: "boolean";
      };
      msgVpnName: {
          description: "The name of the Message VPN.";
          type: "string";
      };
      password: {
          description: "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 `\"\"`.";
          type: "string";
      };
      queueBinding: {
          description: "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 `\"\"`.";
          type: "string";
      };
      remoteMsgVpnInterface: {
          description: "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.";
          type: "string";
      };
      remoteMsgVpnLocation: {
          description: "The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\").";
          type: "string";
      };
      remoteMsgVpnName: {
          description: "The name of the remote Message VPN.";
          type: "string";
      };
      tlsEnabled: {
          description: "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`.";
          type: "boolean";
      };
      unidirectionalClientProfile: {
          description: "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\"`.";
          type: "string";
      };
  }

  • bridgeName: {
        description: "The name of the Bridge.";
        type: "string";
    }

    • description: "The name of the Bridge."

    • type: "string"

  • bridgeVirtualRouter: {
        type: "Enum";
    }

    • type: "Enum"

  • clientUsername: {
        description: "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 `\"\"`.";
        type: "string";
    }

    • description: "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 `\"\"`."

    • type: "string"

  • compressedDataEnabled: {
        description: "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`.";
        type: "boolean";
    }

    • description: "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`."

    • type: "boolean"

  • connectOrder: {
        description: "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`.";
        format: "int32";
        type: "number";
    }

    • description: "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`."

    • format: "int32"

    • type: "number"

  • egressFlowWindowSize: {
        description: "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`.";
        format: "int64";
        type: "number";
    }

    • description: "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`."

    • format: "int64"

    • type: "number"

  • enabled: {
        description: "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`.";
        type: "boolean";
    }

    • description: "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`."

    • type: "boolean"

  • msgVpnName: {
        description: "The name of the Message VPN.";
        type: "string";
    }

    • description: "The name of the Message VPN."

    • type: "string"

  • password: {
        description: "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 `\"\"`.";
        type: "string";
    }

    • description: "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 `\"\"`."

    • type: "string"

  • queueBinding: {
        description: "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 `\"\"`.";
        type: "string";
    }

    • description: "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 `\"\"`."

    • type: "string"

  • remoteMsgVpnInterface: {
        description: "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.";
        type: "string";
    }

    • description: "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."

    • type: "string"

  • remoteMsgVpnLocation: {
        description: "The location of the remote Message VPN as either an FQDN with port, IP address with port, or virtual router name (starting with \"v:\").";
        type: "string";
    }

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

    • type: "string"

  • remoteMsgVpnName: {
        description: "The name of the remote Message VPN.";
        type: "string";
    }

    • description: "The name of the remote Message VPN."

    • type: "string"

  • tlsEnabled: {
        description: "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`.";
        type: "boolean";
    }

    • description: "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`."

    • type: "boolean"

  • unidirectionalClientProfile: {
        description: "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\"`.";
        type: "string";
    }

    • description: "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\"`."

    • type: "string"