Variable $MsgVpnConst

$MsgVpn: {
    properties: {
        alias: {
            description: "The name of another Message VPN which this Message VPN is an alias for. When this Message VPN is enabled, the alias has no effect. When this Message VPN is disabled, Clients (but not Bridges and routing Links) logging into this Message VPN are automatically logged in to the other Message VPN, and authentication and authorization take place in the context of the other Message VPN.\n\n Aliases may form a non-circular chain, cascading one to the next. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.14.";
            type: "string";
        };
        authenticationBasicEnabled: {
            description: "Enable or disable basic authentication for clients connecting to the Message VPN. Basic authentication is authentication that involves the use of a username and password to prove identity. If a user provides credentials for a different authentication scheme, this setting is not applicable. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.";
            type: "boolean";
        };
        authenticationBasicProfileName: {
            description: "The name of the RADIUS or LDAP Profile to use for basic authentication. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"default\"`.";
            type: "string";
        };
        authenticationBasicRadiusDomain: {
            description: "The RADIUS domain to use for basic authentication. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.";
            type: "string";
        };
        authenticationBasicType: {
            type: "Enum";
        };
        authenticationClientCertAllowApiProvidedUsernameEnabled: {
            description: "Enable or disable allowing a client to specify a Client Username via the API connect method. When disabled, the certificate CN (Common Name) is always used. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
            type: "boolean";
        };
        authenticationClientCertCertificateMatchingRulesEnabled: {
            description: "Enable or disable certificate matching rules. When disabled, any valid certificate is accepted. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.27.";
            type: "boolean";
        };
        authenticationClientCertEnabled: {
            description: "Enable or disable client certificate authentication in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
            type: "boolean";
        };
        authenticationClientCertMaxChainDepth: {
            description: "The maximum depth for a client certificate chain. The depth of a chain is defined as the number of signing CA certificates that are present in the chain back to a trusted self-signed root CA certificate. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`.";
            format: "int64";
            type: "number";
        };
        authenticationClientCertRevocationCheckMode: {
            type: "Enum";
        };
        authenticationClientCertUsernameSource: {
            type: "Enum";
        };
        authenticationClientCertValidateDateEnabled: {
            description: "Enable or disable validation of the \"Not Before\" and \"Not After\" validity dates in the client certificate. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.";
            type: "boolean";
        };
        authenticationKerberosAllowApiProvidedUsernameEnabled: {
            description: "Enable or disable allowing a client to specify a Client Username via the API connect method. When disabled, the Kerberos Principal name is always used. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
            type: "boolean";
        };
        authenticationKerberosEnabled: {
            description: "Enable or disable Kerberos authentication in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
            type: "boolean";
        };
        authenticationOauthDefaultProfileName: {
            description: "The name of the profile to use when the client does not supply a profile name. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.25.";
            type: "string";
        };
        authenticationOauthDefaultProviderName: {
            description: "The name of the provider to use when the client does not supply a provider name. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Deprecated since 2.25. authenticationOauthDefaultProviderName and authenticationOauthProviders replaced by authenticationOauthDefaultProfileName and authenticationOauthProfiles.";
            type: "string";
        };
        authenticationOauthEnabled: {
            description: "Enable or disable OAuth authentication. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.13.";
            type: "boolean";
        };
        authorizationLdapGroupMembershipAttributeName: {
            description: "The name of the attribute that is retrieved from the LDAP server as part of the LDAP search when authorizing a client connecting to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"memberOf\"`.";
            type: "string";
        };
        authorizationLdapTrimClientUsernameDomainEnabled: {
            description: "Enable or disable client-username domain trimming for LDAP lookups of client connections. When enabled, the value of $CLIENT_USERNAME (when used for searching) will be truncated at the first occurance of the @ character. For example, if the client-username is in the form of an email address, then the domain portion will be removed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.13.";
            type: "boolean";
        };
        authorizationProfileName: {
            description: "The name of the LDAP Profile to use for client authorization. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.";
            type: "string";
        };
        authorizationType: {
            type: "Enum";
        };
        bridgingTlsServerCertEnforceTrustedCommonNameEnabled: {
            description: "Enable or disable validation of the Common Name (CN) in the server certificate from the remote broker. If enabled, the Common Name is checked against the list of Trusted Common Names configured for the Bridge. Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.";
            type: "boolean";
        };
        bridgingTlsServerCertMaxChainDepth: {
            description: "The maximum depth for a server certificate chain. The depth of a chain is defined as the number of signing CA certificates that are present in the chain back to a trusted self-signed root CA certificate. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`.";
            format: "int64";
            type: "number";
        };
        bridgingTlsServerCertValidateDateEnabled: {
            description: "Enable or disable validation of the \"Not Before\" and \"Not After\" validity dates in the server certificate. When disabled, a certificate will be accepted even if the certificate is not valid based on these dates. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.";
            type: "boolean";
        };
        bridgingTlsServerCertValidateNameEnabled: {
            description: "Enable or disable the standard TLS authentication mechanism of verifying the name used to connect to the bridge. If enabled, the name used to connect to the bridge is checked against the names specified in the certificate returned by the remote router. Legacy Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is also enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.18.";
            type: "boolean";
        };
        distributedCacheManagementEnabled: {
            description: "Enable or disable managing of cache instances over the message bus. The default value is `true`. Deprecated since 2.28. Distributed cache mangement is now redundancy aware and thus no longer requires administrative intervention for operational state.";
            type: "boolean";
        };
        dmrEnabled: {
            description: "Enable or disable Dynamic Message Routing (DMR) for the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.11.";
            type: "boolean";
        };
        enabled: {
            description: "Enable or disable the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
            type: "boolean";
        };
        eventConnectionCountThreshold: {
            type: "EventThreshold";
        };
        eventEgressFlowCountThreshold: {
            type: "EventThreshold";
        };
        eventEgressMsgRateThreshold: {
            type: "EventThresholdByValue";
        };
        eventEndpointCountThreshold: {
            type: "EventThreshold";
        };
        eventIngressFlowCountThreshold: {
            type: "EventThreshold";
        };
        eventIngressMsgRateThreshold: {
            type: "EventThresholdByValue";
        };
        eventLargeMsgThreshold: {
            description: "The threshold, in kilobytes, after which a message is considered to be large for the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1024`.";
            format: "int64";
            type: "number";
        };
        eventLogTag: {
            description: "A prefix applied to all published Events in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.";
            type: "string";
        };
        eventMsgSpoolUsageThreshold: {
            type: "EventThreshold";
        };
        eventPublishClientEnabled: {
            description: "Enable or disable Client level Event message publishing. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
            type: "boolean";
        };
        eventPublishMsgVpnEnabled: {
            description: "Enable or disable Message VPN level Event message publishing. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
            type: "boolean";
        };
        eventPublishSubscriptionMode: {
            type: "Enum";
        };
        eventPublishTopicFormatMqttEnabled: {
            description: "Enable or disable Event publish topics in MQTT format. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
            type: "boolean";
        };
        eventPublishTopicFormatSmfEnabled: {
            description: "Enable or disable Event publish topics in SMF format. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.";
            type: "boolean";
        };
        eventServiceAmqpConnectionCountThreshold: {
            type: "EventThreshold";
        };
        eventServiceMqttConnectionCountThreshold: {
            type: "EventThreshold";
        };
        eventServiceRestIncomingConnectionCountThreshold: {
            type: "EventThreshold";
        };
        eventServiceSmfConnectionCountThreshold: {
            type: "EventThreshold";
        };
        eventServiceWebConnectionCountThreshold: {
            type: "EventThreshold";
        };
        eventSubscriptionCountThreshold: {
            type: "EventThreshold";
        };
        eventTransactedSessionCountThreshold: {
            type: "EventThreshold";
        };
        eventTransactionCountThreshold: {
            type: "EventThreshold";
        };
        exportSubscriptionsEnabled: {
            description: "Enable or disable the export of subscriptions in the Message VPN to other routers in the network over Neighbor links. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
            type: "boolean";
        };
        jndiEnabled: {
            description: "Enable or disable JNDI access for clients in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.2.";
            type: "boolean";
        };
        maxConnectionCount: {
            description: "The maximum number of client connections to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform.";
            format: "int64";
            type: "number";
        };
        maxEgressFlowCount: {
            description: "The maximum number of transmit flows that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`.";
            format: "int64";
            type: "number";
        };
        maxEndpointCount: {
            description: "The maximum number of Queues and Topic Endpoints that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`.";
            format: "int64";
            type: "number";
        };
        maxIngressFlowCount: {
            description: "The maximum number of receive flows that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`.";
            format: "int64";
            type: "number";
        };
        maxMsgSpoolUsage: {
            description: "The maximum message spool usage by the Message VPN, in megabytes. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.";
            format: "int64";
            type: "number";
        };
        maxSubscriptionCount: {
            description: "The maximum number of local client subscriptions that can be added to the Message VPN. This limit is not enforced when a subscription is added using a management interface, such as CLI or SEMP. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform.";
            format: "int64";
            type: "number";
        };
        maxTransactedSessionCount: {
            description: "The maximum number of transacted sessions that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform.";
            format: "int64";
            type: "number";
        };
        maxTransactionCount: {
            description: "The maximum number of transactions that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform.";
            format: "int64";
            type: "number";
        };
        mqttRetainMaxMemory: {
            description: "The maximum total memory usage of the MQTT Retain feature for this Message VPN, in MB. If the maximum memory is reached, any arriving retain messages that require more memory are discarded. A value of -1 indicates that the memory is bounded only by the global max memory limit. A value of 0 prevents MQTT Retain from becoming operational. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `-1`. Available since 2.11.";
            format: "int32";
            type: "number";
        };
        msgVpnName: {
            description: "The name of the Message VPN.";
            type: "string";
        };
        replicationAckPropagationIntervalMsgCount: {
            description: "The acknowledgement (ACK) propagation interval for the replication Bridge, in number of replicated messages. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `20`.";
            format: "int64";
            type: "number";
        };
        replicationBridgeAuthenticationBasicClientUsername: {
            description: "The Client Username the replication Bridge uses to login to the remote Message VPN. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.";
            type: "string";
        };
        replicationBridgeAuthenticationBasicPassword: {
            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 via config-sync. The default value is `\"\"`.";
            type: "string";
        };
        replicationBridgeAuthenticationClientCertContent: {
            description: "The PEM formatted content for the client certificate used by this bridge to login to the Remote Message VPN. It must consist of a private key and between one and three certificates comprising the certificate trust chain. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changing this attribute requires an HTTPS connection. The default value is `\"\"`. Available since 2.9.";
            type: "string";
        };
        replicationBridgeAuthenticationClientCertPassword: {
            description: "The password for the client certificate. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changing this attribute requires an HTTPS connection. The default value is `\"\"`. Available since 2.9.";
            type: "string";
        };
        replicationBridgeAuthenticationScheme: {
            type: "Enum";
        };
        replicationBridgeCompressedDataEnabled: {
            description: "Enable or disable use of compression for the replication Bridge. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.";
            type: "boolean";
        };
        replicationBridgeEgressFlowWindowSize: {
            description: "The size of the window used for guaranteed messages published to the replication Bridge, in messages. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `255`.";
            format: "int64";
            type: "number";
        };
        replicationBridgeRetryDelay: {
            description: "The number of seconds that must pass before retrying the replication Bridge connection. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `3`.";
            format: "int64";
            type: "number";
        };
        replicationBridgeTlsEnabled: {
            description: "Enable or disable use of encryption (TLS) for the replication Bridge connection. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.";
            type: "boolean";
        };
        replicationBridgeUnidirectionalClientProfileName: {
            description: "The Client Profile for the unidirectional replication Bridge in the Message VPN. It is used only for the TCP parameters. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"#client-profile\"`.";
            type: "string";
        };
        replicationEnabled: {
            description: "Enable or disable replication for the Message VPN. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.";
            type: "boolean";
        };
        replicationEnabledQueueBehavior: {
            type: "Enum";
        };
        replicationQueueMaxMsgSpoolUsage: {
            description: "The maximum message spool usage by the replication Bridge local Queue (quota), in megabytes. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `60000`.";
            format: "int64";
            type: "number";
        };
        replicationQueueRejectMsgToSenderOnDiscardEnabled: {
            description: "Enable or disable whether messages discarded on the replication Bridge local Queue are rejected back to the sender. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.";
            type: "boolean";
        };
        replicationRejectMsgWhenSyncIneligibleEnabled: {
            description: "Enable or disable whether guaranteed messages published to synchronously replicated Topics are rejected back to the sender when synchronous replication becomes ineligible. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
            type: "boolean";
        };
        replicationRole: {
            type: "Enum";
        };
        replicationTransactionMode: {
            type: "Enum";
        };
        restTlsServerCertEnforceTrustedCommonNameEnabled: {
            description: "Enable or disable validation of the Common Name (CN) in the server certificate from the remote REST Consumer. If enabled, the Common Name is checked against the list of Trusted Common Names configured for the REST Consumer. Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Deprecated since 2.17. Common Name validation has been replaced by Server Certificate Name validation.";
            type: "boolean";
        };
        restTlsServerCertMaxChainDepth: {
            description: "The maximum depth for a REST Consumer server certificate chain. The depth of a chain is defined as the number of signing CA certificates that are present in the chain back to a trusted self-signed root CA certificate. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`.";
            format: "int64";
            type: "number";
        };
        restTlsServerCertValidateDateEnabled: {
            description: "Enable or disable validation of the \"Not Before\" and \"Not After\" validity dates in the REST Consumer server certificate. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.";
            type: "boolean";
        };
        restTlsServerCertValidateNameEnabled: {
            description: "Enable or disable the standard TLS authentication mechanism of verifying the name used to connect to the remote REST Consumer. If enabled, the name used to connect to the remote REST Consumer is checked against the names specified in the certificate returned by the remote router. Legacy Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is also enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.17.";
            type: "boolean";
        };
        sempOverMsgBusAdminClientEnabled: {
            description: "Enable or disable \"admin client\" SEMP over the message bus commands for the current Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
            type: "boolean";
        };
        sempOverMsgBusAdminDistributedCacheEnabled: {
            description: "Enable or disable \"admin distributed-cache\" SEMP over the message bus commands for the current Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
            type: "boolean";
        };
        sempOverMsgBusAdminEnabled: {
            description: "Enable or disable \"admin\" SEMP over the message bus commands for the current Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
            type: "boolean";
        };
        sempOverMsgBusEnabled: {
            description: "Enable or disable SEMP over the message bus for the current Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.";
            type: "boolean";
        };
        sempOverMsgBusShowEnabled: {
            description: "Enable or disable \"show\" SEMP over the message bus commands for the current Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
            type: "boolean";
        };
        serviceAmqpMaxConnectionCount: {
            description: "The maximum number of AMQP client connections that can be simultaneously connected to the Message VPN. This value may be higher than supported by the platform. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform. Available since 2.7.";
            format: "int64";
            type: "number";
        };
        serviceAmqpPlainTextEnabled: {
            description: "Enable or disable the plain-text AMQP service in the Message VPN. Disabling causes clients connected to the corresponding listen-port to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.7.";
            type: "boolean";
        };
        serviceAmqpPlainTextListenPort: {
            description: "The port number for plain-text AMQP clients that connect to the Message VPN. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.7.";
            format: "int64";
            type: "number";
        };
        serviceAmqpTlsEnabled: {
            description: "Enable or disable the use of encryption (TLS) for the AMQP service in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.7.";
            type: "boolean";
        };
        serviceAmqpTlsListenPort: {
            description: "The port number for AMQP clients that connect to the Message VPN over TLS. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.7.";
            format: "int64";
            type: "number";
        };
        serviceMqttAuthenticationClientCertRequest: {
            type: "Enum";
        };
        serviceMqttMaxConnectionCount: {
            description: "The maximum number of MQTT client connections that can be simultaneously connected to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform. Available since 2.1.";
            format: "int64";
            type: "number";
        };
        serviceMqttPlainTextEnabled: {
            description: "Enable or disable the plain-text MQTT service in the Message VPN. Disabling causes clients currently connected to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.1.";
            type: "boolean";
        };
        serviceMqttPlainTextListenPort: {
            description: "The port number for plain-text MQTT clients that connect to the Message VPN. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.1.";
            format: "int64";
            type: "number";
        };
        serviceMqttTlsEnabled: {
            description: "Enable or disable the use of encryption (TLS) for the MQTT service in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.1.";
            type: "boolean";
        };
        serviceMqttTlsListenPort: {
            description: "The port number for MQTT clients that connect to the Message VPN over TLS. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.1.";
            format: "int64";
            type: "number";
        };
        serviceMqttTlsWebSocketEnabled: {
            description: "Enable or disable the use of encrypted WebSocket (WebSocket over TLS) for the MQTT service in the Message VPN. Disabling causes clients currently connected by encrypted WebSocket to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.1.";
            type: "boolean";
        };
        serviceMqttTlsWebSocketListenPort: {
            description: "The port number for MQTT clients that connect to the Message VPN using WebSocket over TLS. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.1.";
            format: "int64";
            type: "number";
        };
        serviceMqttWebSocketEnabled: {
            description: "Enable or disable the use of WebSocket for the MQTT service in the Message VPN. Disabling causes clients currently connected by WebSocket to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.1.";
            type: "boolean";
        };
        serviceMqttWebSocketListenPort: {
            description: "The port number for plain-text MQTT clients that connect to the Message VPN using WebSocket. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.1.";
            format: "int64";
            type: "number";
        };
        serviceRestIncomingAuthenticationClientCertRequest: {
            type: "Enum";
        };
        serviceRestIncomingAuthorizationHeaderHandling: {
            type: "Enum";
        };
        serviceRestIncomingMaxConnectionCount: {
            description: "The maximum number of REST incoming client connections that can be simultaneously connected to the Message VPN. This value may be higher than supported by the platform. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform.";
            format: "int64";
            type: "number";
        };
        serviceRestIncomingPlainTextEnabled: {
            description: "Enable or disable the plain-text REST service for incoming clients in the Message VPN. Disabling causes clients currently connected to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
            type: "boolean";
        };
        serviceRestIncomingPlainTextListenPort: {
            description: "The port number for incoming plain-text REST clients that connect to the Message VPN. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.";
            format: "int64";
            type: "number";
        };
        serviceRestIncomingTlsEnabled: {
            description: "Enable or disable the use of encryption (TLS) for the REST service for incoming clients in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
            type: "boolean";
        };
        serviceRestIncomingTlsListenPort: {
            description: "The port number for incoming REST clients that connect to the Message VPN over TLS. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.";
            format: "int64";
            type: "number";
        };
        serviceRestMode: {
            type: "Enum";
        };
        serviceRestOutgoingMaxConnectionCount: {
            description: "The maximum number of REST Consumer (outgoing) client connections that can be simultaneously connected to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform.";
            format: "int64";
            type: "number";
        };
        serviceSmfMaxConnectionCount: {
            description: "The maximum number of SMF client connections that can be simultaneously connected to the Message VPN. This value may be higher than supported by the platform. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform.";
            format: "int64";
            type: "number";
        };
        serviceSmfPlainTextEnabled: {
            description: "Enable or disable the plain-text SMF service in the Message VPN. Disabling causes clients currently connected to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.";
            type: "boolean";
        };
        serviceSmfTlsEnabled: {
            description: "Enable or disable the use of encryption (TLS) for the SMF service in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.";
            type: "boolean";
        };
        serviceWebAuthenticationClientCertRequest: {
            type: "Enum";
        };
        serviceWebMaxConnectionCount: {
            description: "The maximum number of Web Transport client connections that can be simultaneously connected to the Message VPN. This value may be higher than supported by the platform. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform.";
            format: "int64";
            type: "number";
        };
        serviceWebPlainTextEnabled: {
            description: "Enable or disable the plain-text Web Transport service in the Message VPN. Disabling causes clients currently connected to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.";
            type: "boolean";
        };
        serviceWebTlsEnabled: {
            description: "Enable or disable the use of TLS for the Web Transport service in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.";
            type: "boolean";
        };
        tlsAllowDowngradeToPlainTextEnabled: {
            description: "Enable or disable the allowing of TLS SMF clients to downgrade their connections to plain-text connections. Changing this will not affect existing connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
            type: "boolean";
        };
    };
} = ...

Type declaration

  • properties: {
        alias: {
            description: "The name of another Message VPN which this Message VPN is an alias for. When this Message VPN is enabled, the alias has no effect. When this Message VPN is disabled, Clients (but not Bridges and routing Links) logging into this Message VPN are automatically logged in to the other Message VPN, and authentication and authorization take place in the context of the other Message VPN.\n\n Aliases may form a non-circular chain, cascading one to the next. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.14.";
            type: "string";
        };
        authenticationBasicEnabled: {
            description: "Enable or disable basic authentication for clients connecting to the Message VPN. Basic authentication is authentication that involves the use of a username and password to prove identity. If a user provides credentials for a different authentication scheme, this setting is not applicable. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.";
            type: "boolean";
        };
        authenticationBasicProfileName: {
            description: "The name of the RADIUS or LDAP Profile to use for basic authentication. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"default\"`.";
            type: "string";
        };
        authenticationBasicRadiusDomain: {
            description: "The RADIUS domain to use for basic authentication. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.";
            type: "string";
        };
        authenticationBasicType: {
            type: "Enum";
        };
        authenticationClientCertAllowApiProvidedUsernameEnabled: {
            description: "Enable or disable allowing a client to specify a Client Username via the API connect method. When disabled, the certificate CN (Common Name) is always used. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
            type: "boolean";
        };
        authenticationClientCertCertificateMatchingRulesEnabled: {
            description: "Enable or disable certificate matching rules. When disabled, any valid certificate is accepted. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.27.";
            type: "boolean";
        };
        authenticationClientCertEnabled: {
            description: "Enable or disable client certificate authentication in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
            type: "boolean";
        };
        authenticationClientCertMaxChainDepth: {
            description: "The maximum depth for a client certificate chain. The depth of a chain is defined as the number of signing CA certificates that are present in the chain back to a trusted self-signed root CA certificate. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`.";
            format: "int64";
            type: "number";
        };
        authenticationClientCertRevocationCheckMode: {
            type: "Enum";
        };
        authenticationClientCertUsernameSource: {
            type: "Enum";
        };
        authenticationClientCertValidateDateEnabled: {
            description: "Enable or disable validation of the \"Not Before\" and \"Not After\" validity dates in the client certificate. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.";
            type: "boolean";
        };
        authenticationKerberosAllowApiProvidedUsernameEnabled: {
            description: "Enable or disable allowing a client to specify a Client Username via the API connect method. When disabled, the Kerberos Principal name is always used. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
            type: "boolean";
        };
        authenticationKerberosEnabled: {
            description: "Enable or disable Kerberos authentication in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
            type: "boolean";
        };
        authenticationOauthDefaultProfileName: {
            description: "The name of the profile to use when the client does not supply a profile name. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.25.";
            type: "string";
        };
        authenticationOauthDefaultProviderName: {
            description: "The name of the provider to use when the client does not supply a provider name. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Deprecated since 2.25. authenticationOauthDefaultProviderName and authenticationOauthProviders replaced by authenticationOauthDefaultProfileName and authenticationOauthProfiles.";
            type: "string";
        };
        authenticationOauthEnabled: {
            description: "Enable or disable OAuth authentication. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.13.";
            type: "boolean";
        };
        authorizationLdapGroupMembershipAttributeName: {
            description: "The name of the attribute that is retrieved from the LDAP server as part of the LDAP search when authorizing a client connecting to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"memberOf\"`.";
            type: "string";
        };
        authorizationLdapTrimClientUsernameDomainEnabled: {
            description: "Enable or disable client-username domain trimming for LDAP lookups of client connections. When enabled, the value of $CLIENT_USERNAME (when used for searching) will be truncated at the first occurance of the @ character. For example, if the client-username is in the form of an email address, then the domain portion will be removed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.13.";
            type: "boolean";
        };
        authorizationProfileName: {
            description: "The name of the LDAP Profile to use for client authorization. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.";
            type: "string";
        };
        authorizationType: {
            type: "Enum";
        };
        bridgingTlsServerCertEnforceTrustedCommonNameEnabled: {
            description: "Enable or disable validation of the Common Name (CN) in the server certificate from the remote broker. If enabled, the Common Name is checked against the list of Trusted Common Names configured for the Bridge. Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.";
            type: "boolean";
        };
        bridgingTlsServerCertMaxChainDepth: {
            description: "The maximum depth for a server certificate chain. The depth of a chain is defined as the number of signing CA certificates that are present in the chain back to a trusted self-signed root CA certificate. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`.";
            format: "int64";
            type: "number";
        };
        bridgingTlsServerCertValidateDateEnabled: {
            description: "Enable or disable validation of the \"Not Before\" and \"Not After\" validity dates in the server certificate. When disabled, a certificate will be accepted even if the certificate is not valid based on these dates. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.";
            type: "boolean";
        };
        bridgingTlsServerCertValidateNameEnabled: {
            description: "Enable or disable the standard TLS authentication mechanism of verifying the name used to connect to the bridge. If enabled, the name used to connect to the bridge is checked against the names specified in the certificate returned by the remote router. Legacy Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is also enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.18.";
            type: "boolean";
        };
        distributedCacheManagementEnabled: {
            description: "Enable or disable managing of cache instances over the message bus. The default value is `true`. Deprecated since 2.28. Distributed cache mangement is now redundancy aware and thus no longer requires administrative intervention for operational state.";
            type: "boolean";
        };
        dmrEnabled: {
            description: "Enable or disable Dynamic Message Routing (DMR) for the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.11.";
            type: "boolean";
        };
        enabled: {
            description: "Enable or disable the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
            type: "boolean";
        };
        eventConnectionCountThreshold: {
            type: "EventThreshold";
        };
        eventEgressFlowCountThreshold: {
            type: "EventThreshold";
        };
        eventEgressMsgRateThreshold: {
            type: "EventThresholdByValue";
        };
        eventEndpointCountThreshold: {
            type: "EventThreshold";
        };
        eventIngressFlowCountThreshold: {
            type: "EventThreshold";
        };
        eventIngressMsgRateThreshold: {
            type: "EventThresholdByValue";
        };
        eventLargeMsgThreshold: {
            description: "The threshold, in kilobytes, after which a message is considered to be large for the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1024`.";
            format: "int64";
            type: "number";
        };
        eventLogTag: {
            description: "A prefix applied to all published Events in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.";
            type: "string";
        };
        eventMsgSpoolUsageThreshold: {
            type: "EventThreshold";
        };
        eventPublishClientEnabled: {
            description: "Enable or disable Client level Event message publishing. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
            type: "boolean";
        };
        eventPublishMsgVpnEnabled: {
            description: "Enable or disable Message VPN level Event message publishing. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
            type: "boolean";
        };
        eventPublishSubscriptionMode: {
            type: "Enum";
        };
        eventPublishTopicFormatMqttEnabled: {
            description: "Enable or disable Event publish topics in MQTT format. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
            type: "boolean";
        };
        eventPublishTopicFormatSmfEnabled: {
            description: "Enable or disable Event publish topics in SMF format. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.";
            type: "boolean";
        };
        eventServiceAmqpConnectionCountThreshold: {
            type: "EventThreshold";
        };
        eventServiceMqttConnectionCountThreshold: {
            type: "EventThreshold";
        };
        eventServiceRestIncomingConnectionCountThreshold: {
            type: "EventThreshold";
        };
        eventServiceSmfConnectionCountThreshold: {
            type: "EventThreshold";
        };
        eventServiceWebConnectionCountThreshold: {
            type: "EventThreshold";
        };
        eventSubscriptionCountThreshold: {
            type: "EventThreshold";
        };
        eventTransactedSessionCountThreshold: {
            type: "EventThreshold";
        };
        eventTransactionCountThreshold: {
            type: "EventThreshold";
        };
        exportSubscriptionsEnabled: {
            description: "Enable or disable the export of subscriptions in the Message VPN to other routers in the network over Neighbor links. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
            type: "boolean";
        };
        jndiEnabled: {
            description: "Enable or disable JNDI access for clients in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.2.";
            type: "boolean";
        };
        maxConnectionCount: {
            description: "The maximum number of client connections to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform.";
            format: "int64";
            type: "number";
        };
        maxEgressFlowCount: {
            description: "The maximum number of transmit flows that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`.";
            format: "int64";
            type: "number";
        };
        maxEndpointCount: {
            description: "The maximum number of Queues and Topic Endpoints that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`.";
            format: "int64";
            type: "number";
        };
        maxIngressFlowCount: {
            description: "The maximum number of receive flows that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`.";
            format: "int64";
            type: "number";
        };
        maxMsgSpoolUsage: {
            description: "The maximum message spool usage by the Message VPN, in megabytes. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.";
            format: "int64";
            type: "number";
        };
        maxSubscriptionCount: {
            description: "The maximum number of local client subscriptions that can be added to the Message VPN. This limit is not enforced when a subscription is added using a management interface, such as CLI or SEMP. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform.";
            format: "int64";
            type: "number";
        };
        maxTransactedSessionCount: {
            description: "The maximum number of transacted sessions that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform.";
            format: "int64";
            type: "number";
        };
        maxTransactionCount: {
            description: "The maximum number of transactions that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform.";
            format: "int64";
            type: "number";
        };
        mqttRetainMaxMemory: {
            description: "The maximum total memory usage of the MQTT Retain feature for this Message VPN, in MB. If the maximum memory is reached, any arriving retain messages that require more memory are discarded. A value of -1 indicates that the memory is bounded only by the global max memory limit. A value of 0 prevents MQTT Retain from becoming operational. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `-1`. Available since 2.11.";
            format: "int32";
            type: "number";
        };
        msgVpnName: {
            description: "The name of the Message VPN.";
            type: "string";
        };
        replicationAckPropagationIntervalMsgCount: {
            description: "The acknowledgement (ACK) propagation interval for the replication Bridge, in number of replicated messages. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `20`.";
            format: "int64";
            type: "number";
        };
        replicationBridgeAuthenticationBasicClientUsername: {
            description: "The Client Username the replication Bridge uses to login to the remote Message VPN. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.";
            type: "string";
        };
        replicationBridgeAuthenticationBasicPassword: {
            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 via config-sync. The default value is `\"\"`.";
            type: "string";
        };
        replicationBridgeAuthenticationClientCertContent: {
            description: "The PEM formatted content for the client certificate used by this bridge to login to the Remote Message VPN. It must consist of a private key and between one and three certificates comprising the certificate trust chain. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changing this attribute requires an HTTPS connection. The default value is `\"\"`. Available since 2.9.";
            type: "string";
        };
        replicationBridgeAuthenticationClientCertPassword: {
            description: "The password for the client certificate. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changing this attribute requires an HTTPS connection. The default value is `\"\"`. Available since 2.9.";
            type: "string";
        };
        replicationBridgeAuthenticationScheme: {
            type: "Enum";
        };
        replicationBridgeCompressedDataEnabled: {
            description: "Enable or disable use of compression for the replication Bridge. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.";
            type: "boolean";
        };
        replicationBridgeEgressFlowWindowSize: {
            description: "The size of the window used for guaranteed messages published to the replication Bridge, in messages. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `255`.";
            format: "int64";
            type: "number";
        };
        replicationBridgeRetryDelay: {
            description: "The number of seconds that must pass before retrying the replication Bridge connection. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `3`.";
            format: "int64";
            type: "number";
        };
        replicationBridgeTlsEnabled: {
            description: "Enable or disable use of encryption (TLS) for the replication Bridge connection. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.";
            type: "boolean";
        };
        replicationBridgeUnidirectionalClientProfileName: {
            description: "The Client Profile for the unidirectional replication Bridge in the Message VPN. It is used only for the TCP parameters. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"#client-profile\"`.";
            type: "string";
        };
        replicationEnabled: {
            description: "Enable or disable replication for the Message VPN. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.";
            type: "boolean";
        };
        replicationEnabledQueueBehavior: {
            type: "Enum";
        };
        replicationQueueMaxMsgSpoolUsage: {
            description: "The maximum message spool usage by the replication Bridge local Queue (quota), in megabytes. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `60000`.";
            format: "int64";
            type: "number";
        };
        replicationQueueRejectMsgToSenderOnDiscardEnabled: {
            description: "Enable or disable whether messages discarded on the replication Bridge local Queue are rejected back to the sender. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.";
            type: "boolean";
        };
        replicationRejectMsgWhenSyncIneligibleEnabled: {
            description: "Enable or disable whether guaranteed messages published to synchronously replicated Topics are rejected back to the sender when synchronous replication becomes ineligible. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
            type: "boolean";
        };
        replicationRole: {
            type: "Enum";
        };
        replicationTransactionMode: {
            type: "Enum";
        };
        restTlsServerCertEnforceTrustedCommonNameEnabled: {
            description: "Enable or disable validation of the Common Name (CN) in the server certificate from the remote REST Consumer. If enabled, the Common Name is checked against the list of Trusted Common Names configured for the REST Consumer. Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Deprecated since 2.17. Common Name validation has been replaced by Server Certificate Name validation.";
            type: "boolean";
        };
        restTlsServerCertMaxChainDepth: {
            description: "The maximum depth for a REST Consumer server certificate chain. The depth of a chain is defined as the number of signing CA certificates that are present in the chain back to a trusted self-signed root CA certificate. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`.";
            format: "int64";
            type: "number";
        };
        restTlsServerCertValidateDateEnabled: {
            description: "Enable or disable validation of the \"Not Before\" and \"Not After\" validity dates in the REST Consumer server certificate. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.";
            type: "boolean";
        };
        restTlsServerCertValidateNameEnabled: {
            description: "Enable or disable the standard TLS authentication mechanism of verifying the name used to connect to the remote REST Consumer. If enabled, the name used to connect to the remote REST Consumer is checked against the names specified in the certificate returned by the remote router. Legacy Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is also enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.17.";
            type: "boolean";
        };
        sempOverMsgBusAdminClientEnabled: {
            description: "Enable or disable \"admin client\" SEMP over the message bus commands for the current Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
            type: "boolean";
        };
        sempOverMsgBusAdminDistributedCacheEnabled: {
            description: "Enable or disable \"admin distributed-cache\" SEMP over the message bus commands for the current Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
            type: "boolean";
        };
        sempOverMsgBusAdminEnabled: {
            description: "Enable or disable \"admin\" SEMP over the message bus commands for the current Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
            type: "boolean";
        };
        sempOverMsgBusEnabled: {
            description: "Enable or disable SEMP over the message bus for the current Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.";
            type: "boolean";
        };
        sempOverMsgBusShowEnabled: {
            description: "Enable or disable \"show\" SEMP over the message bus commands for the current Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
            type: "boolean";
        };
        serviceAmqpMaxConnectionCount: {
            description: "The maximum number of AMQP client connections that can be simultaneously connected to the Message VPN. This value may be higher than supported by the platform. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform. Available since 2.7.";
            format: "int64";
            type: "number";
        };
        serviceAmqpPlainTextEnabled: {
            description: "Enable or disable the plain-text AMQP service in the Message VPN. Disabling causes clients connected to the corresponding listen-port to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.7.";
            type: "boolean";
        };
        serviceAmqpPlainTextListenPort: {
            description: "The port number for plain-text AMQP clients that connect to the Message VPN. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.7.";
            format: "int64";
            type: "number";
        };
        serviceAmqpTlsEnabled: {
            description: "Enable or disable the use of encryption (TLS) for the AMQP service in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.7.";
            type: "boolean";
        };
        serviceAmqpTlsListenPort: {
            description: "The port number for AMQP clients that connect to the Message VPN over TLS. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.7.";
            format: "int64";
            type: "number";
        };
        serviceMqttAuthenticationClientCertRequest: {
            type: "Enum";
        };
        serviceMqttMaxConnectionCount: {
            description: "The maximum number of MQTT client connections that can be simultaneously connected to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform. Available since 2.1.";
            format: "int64";
            type: "number";
        };
        serviceMqttPlainTextEnabled: {
            description: "Enable or disable the plain-text MQTT service in the Message VPN. Disabling causes clients currently connected to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.1.";
            type: "boolean";
        };
        serviceMqttPlainTextListenPort: {
            description: "The port number for plain-text MQTT clients that connect to the Message VPN. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.1.";
            format: "int64";
            type: "number";
        };
        serviceMqttTlsEnabled: {
            description: "Enable or disable the use of encryption (TLS) for the MQTT service in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.1.";
            type: "boolean";
        };
        serviceMqttTlsListenPort: {
            description: "The port number for MQTT clients that connect to the Message VPN over TLS. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.1.";
            format: "int64";
            type: "number";
        };
        serviceMqttTlsWebSocketEnabled: {
            description: "Enable or disable the use of encrypted WebSocket (WebSocket over TLS) for the MQTT service in the Message VPN. Disabling causes clients currently connected by encrypted WebSocket to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.1.";
            type: "boolean";
        };
        serviceMqttTlsWebSocketListenPort: {
            description: "The port number for MQTT clients that connect to the Message VPN using WebSocket over TLS. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.1.";
            format: "int64";
            type: "number";
        };
        serviceMqttWebSocketEnabled: {
            description: "Enable or disable the use of WebSocket for the MQTT service in the Message VPN. Disabling causes clients currently connected by WebSocket to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.1.";
            type: "boolean";
        };
        serviceMqttWebSocketListenPort: {
            description: "The port number for plain-text MQTT clients that connect to the Message VPN using WebSocket. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.1.";
            format: "int64";
            type: "number";
        };
        serviceRestIncomingAuthenticationClientCertRequest: {
            type: "Enum";
        };
        serviceRestIncomingAuthorizationHeaderHandling: {
            type: "Enum";
        };
        serviceRestIncomingMaxConnectionCount: {
            description: "The maximum number of REST incoming client connections that can be simultaneously connected to the Message VPN. This value may be higher than supported by the platform. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform.";
            format: "int64";
            type: "number";
        };
        serviceRestIncomingPlainTextEnabled: {
            description: "Enable or disable the plain-text REST service for incoming clients in the Message VPN. Disabling causes clients currently connected to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
            type: "boolean";
        };
        serviceRestIncomingPlainTextListenPort: {
            description: "The port number for incoming plain-text REST clients that connect to the Message VPN. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.";
            format: "int64";
            type: "number";
        };
        serviceRestIncomingTlsEnabled: {
            description: "Enable or disable the use of encryption (TLS) for the REST service for incoming clients in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
            type: "boolean";
        };
        serviceRestIncomingTlsListenPort: {
            description: "The port number for incoming REST clients that connect to the Message VPN over TLS. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.";
            format: "int64";
            type: "number";
        };
        serviceRestMode: {
            type: "Enum";
        };
        serviceRestOutgoingMaxConnectionCount: {
            description: "The maximum number of REST Consumer (outgoing) client connections that can be simultaneously connected to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform.";
            format: "int64";
            type: "number";
        };
        serviceSmfMaxConnectionCount: {
            description: "The maximum number of SMF client connections that can be simultaneously connected to the Message VPN. This value may be higher than supported by the platform. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform.";
            format: "int64";
            type: "number";
        };
        serviceSmfPlainTextEnabled: {
            description: "Enable or disable the plain-text SMF service in the Message VPN. Disabling causes clients currently connected to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.";
            type: "boolean";
        };
        serviceSmfTlsEnabled: {
            description: "Enable or disable the use of encryption (TLS) for the SMF service in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.";
            type: "boolean";
        };
        serviceWebAuthenticationClientCertRequest: {
            type: "Enum";
        };
        serviceWebMaxConnectionCount: {
            description: "The maximum number of Web Transport client connections that can be simultaneously connected to the Message VPN. This value may be higher than supported by the platform. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform.";
            format: "int64";
            type: "number";
        };
        serviceWebPlainTextEnabled: {
            description: "Enable or disable the plain-text Web Transport service in the Message VPN. Disabling causes clients currently connected to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.";
            type: "boolean";
        };
        serviceWebTlsEnabled: {
            description: "Enable or disable the use of TLS for the Web Transport service in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.";
            type: "boolean";
        };
        tlsAllowDowngradeToPlainTextEnabled: {
            description: "Enable or disable the allowing of TLS SMF clients to downgrade their connections to plain-text connections. Changing this will not affect existing connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`.";
            type: "boolean";
        };
    }
    • alias: {
          description: "The name of another Message VPN which this Message VPN is an alias for. When this Message VPN is enabled, the alias has no effect. When this Message VPN is disabled, Clients (but not Bridges and routing Links) logging into this Message VPN are automatically logged in to the other Message VPN, and authentication and authorization take place in the context of the other Message VPN.\n\n Aliases may form a non-circular chain, cascading one to the next. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.14.";
          type: "string";
      }
      • description: "The name of another Message VPN which this Message VPN is an alias for. When this Message VPN is enabled, the alias has no effect. When this Message VPN is disabled, Clients (but not Bridges and routing Links) logging into this Message VPN are automatically logged in to the other Message VPN, and authentication and authorization take place in the context of the other Message VPN.\n\n Aliases may form a non-circular chain, cascading one to the next. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.14."
      • type: "string"
    • authenticationBasicEnabled: {
          description: "Enable or disable basic authentication for clients connecting to the Message VPN. Basic authentication is authentication that involves the use of a username and password to prove identity. If a user provides credentials for a different authentication scheme, this setting is not applicable. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.";
          type: "boolean";
      }
      • description: "Enable or disable basic authentication for clients connecting to the Message VPN. Basic authentication is authentication that involves the use of a username and password to prove identity. If a user provides credentials for a different authentication scheme, this setting is not applicable. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`."
      • type: "boolean"
    • authenticationBasicProfileName: {
          description: "The name of the RADIUS or LDAP Profile to use for basic authentication. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"default\"`.";
          type: "string";
      }
      • description: "The name of the RADIUS or LDAP Profile to use for basic authentication. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"default\"`."
      • type: "string"
    • authenticationBasicRadiusDomain: {
          description: "The RADIUS domain to use for basic authentication. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.";
          type: "string";
      }
      • description: "The RADIUS domain to use for basic authentication. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`."
      • type: "string"
    • authenticationBasicType: {
          type: "Enum";
      }
      • type: "Enum"
    • authenticationClientCertAllowApiProvidedUsernameEnabled: {
          description: "Enable or disable allowing a client to specify a Client Username via the API connect method. When disabled, the certificate CN (Common Name) is always used. 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 allowing a client to specify a Client Username via the API connect method. When disabled, the certificate CN (Common Name) is always used. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`."
      • type: "boolean"
    • authenticationClientCertCertificateMatchingRulesEnabled: {
          description: "Enable or disable certificate matching rules. When disabled, any valid certificate is accepted. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.27.";
          type: "boolean";
      }
      • description: "Enable or disable certificate matching rules. When disabled, any valid certificate is accepted. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.27."
      • type: "boolean"
    • authenticationClientCertEnabled: {
          description: "Enable or disable client certificate authentication in the 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 client certificate authentication in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`."
      • type: "boolean"
    • authenticationClientCertMaxChainDepth: {
          description: "The maximum depth for a client certificate chain. The depth of a chain is defined as the number of signing CA certificates that are present in the chain back to a trusted self-signed root CA certificate. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`.";
          format: "int64";
          type: "number";
      }
      • description: "The maximum depth for a client certificate chain. The depth of a chain is defined as the number of signing CA certificates that are present in the chain back to a trusted self-signed root CA certificate. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`."
      • format: "int64"
      • type: "number"
    • authenticationClientCertRevocationCheckMode: {
          type: "Enum";
      }
      • type: "Enum"
    • authenticationClientCertUsernameSource: {
          type: "Enum";
      }
      • type: "Enum"
    • authenticationClientCertValidateDateEnabled: {
          description: "Enable or disable validation of the \"Not Before\" and \"Not After\" validity dates in the client certificate. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.";
          type: "boolean";
      }
      • description: "Enable or disable validation of the \"Not Before\" and \"Not After\" validity dates in the client certificate. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`."
      • type: "boolean"
    • authenticationKerberosAllowApiProvidedUsernameEnabled: {
          description: "Enable or disable allowing a client to specify a Client Username via the API connect method. When disabled, the Kerberos Principal name is always used. 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 allowing a client to specify a Client Username via the API connect method. When disabled, the Kerberos Principal name is always used. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`."
      • type: "boolean"
    • authenticationKerberosEnabled: {
          description: "Enable or disable Kerberos authentication in the 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 Kerberos authentication in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`."
      • type: "boolean"
    • authenticationOauthDefaultProfileName: {
          description: "The name of the profile to use when the client does not supply a profile name. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.25.";
          type: "string";
      }
      • description: "The name of the profile to use when the client does not supply a profile name. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Available since 2.25."
      • type: "string"
    • authenticationOauthDefaultProviderName: {
          description: "The name of the provider to use when the client does not supply a provider name. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Deprecated since 2.25. authenticationOauthDefaultProviderName and authenticationOauthProviders replaced by authenticationOauthDefaultProfileName and authenticationOauthProfiles.";
          type: "string";
      }
      • description: "The name of the provider to use when the client does not supply a provider name. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`. Deprecated since 2.25. authenticationOauthDefaultProviderName and authenticationOauthProviders replaced by authenticationOauthDefaultProfileName and authenticationOauthProfiles."
      • type: "string"
    • authenticationOauthEnabled: {
          description: "Enable or disable OAuth authentication. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.13.";
          type: "boolean";
      }
      • description: "Enable or disable OAuth authentication. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.13."
      • type: "boolean"
    • authorizationLdapGroupMembershipAttributeName: {
          description: "The name of the attribute that is retrieved from the LDAP server as part of the LDAP search when authorizing a client connecting to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"memberOf\"`.";
          type: "string";
      }
      • description: "The name of the attribute that is retrieved from the LDAP server as part of the LDAP search when authorizing a client connecting to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"memberOf\"`."
      • type: "string"
    • authorizationLdapTrimClientUsernameDomainEnabled: {
          description: "Enable or disable client-username domain trimming for LDAP lookups of client connections. When enabled, the value of $CLIENT_USERNAME (when used for searching) will be truncated at the first occurance of the @ character. For example, if the client-username is in the form of an email address, then the domain portion will be removed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.13.";
          type: "boolean";
      }
      • description: "Enable or disable client-username domain trimming for LDAP lookups of client connections. When enabled, the value of $CLIENT_USERNAME (when used for searching) will be truncated at the first occurance of the @ character. For example, if the client-username is in the form of an email address, then the domain portion will be removed. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.13."
      • type: "boolean"
    • authorizationProfileName: {
          description: "The name of the LDAP Profile to use for client authorization. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.";
          type: "string";
      }
      • description: "The name of the LDAP Profile to use for client authorization. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`."
      • type: "string"
    • authorizationType: {
          type: "Enum";
      }
      • type: "Enum"
    • bridgingTlsServerCertEnforceTrustedCommonNameEnabled: {
          description: "Enable or disable validation of the Common Name (CN) in the server certificate from the remote broker. If enabled, the Common Name is checked against the list of Trusted Common Names configured for the Bridge. Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation.";
          type: "boolean";
      }
      • description: "Enable or disable validation of the Common Name (CN) in the server certificate from the remote broker. If enabled, the Common Name is checked against the list of Trusted Common Names configured for the Bridge. Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Deprecated since 2.18. Common Name validation has been replaced by Server Certificate Name validation."
      • type: "boolean"
    • bridgingTlsServerCertMaxChainDepth: {
          description: "The maximum depth for a server certificate chain. The depth of a chain is defined as the number of signing CA certificates that are present in the chain back to a trusted self-signed root CA certificate. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`.";
          format: "int64";
          type: "number";
      }
      • description: "The maximum depth for a server certificate chain. The depth of a chain is defined as the number of signing CA certificates that are present in the chain back to a trusted self-signed root CA certificate. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`."
      • format: "int64"
      • type: "number"
    • bridgingTlsServerCertValidateDateEnabled: {
          description: "Enable or disable validation of the \"Not Before\" and \"Not After\" validity dates in the server certificate. When disabled, a certificate will be accepted even if the certificate is not valid based on these dates. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.";
          type: "boolean";
      }
      • description: "Enable or disable validation of the \"Not Before\" and \"Not After\" validity dates in the server certificate. When disabled, a certificate will be accepted even if the certificate is not valid based on these dates. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`."
      • type: "boolean"
    • bridgingTlsServerCertValidateNameEnabled: {
          description: "Enable or disable the standard TLS authentication mechanism of verifying the name used to connect to the bridge. If enabled, the name used to connect to the bridge is checked against the names specified in the certificate returned by the remote router. Legacy Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is also enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.18.";
          type: "boolean";
      }
      • description: "Enable or disable the standard TLS authentication mechanism of verifying the name used to connect to the bridge. If enabled, the name used to connect to the bridge is checked against the names specified in the certificate returned by the remote router. Legacy Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is also enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.18."
      • type: "boolean"
    • distributedCacheManagementEnabled: {
          description: "Enable or disable managing of cache instances over the message bus. The default value is `true`. Deprecated since 2.28. Distributed cache mangement is now redundancy aware and thus no longer requires administrative intervention for operational state.";
          type: "boolean";
      }
      • description: "Enable or disable managing of cache instances over the message bus. The default value is `true`. Deprecated since 2.28. Distributed cache mangement is now redundancy aware and thus no longer requires administrative intervention for operational state."
      • type: "boolean"
    • dmrEnabled: {
          description: "Enable or disable Dynamic Message Routing (DMR) for the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.11.";
          type: "boolean";
      }
      • description: "Enable or disable Dynamic Message Routing (DMR) for the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.11."
      • type: "boolean"
    • enabled: {
          description: "Enable or disable the 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 Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`."
      • type: "boolean"
    • eventConnectionCountThreshold: {
          type: "EventThreshold";
      }
      • type: "EventThreshold"
    • eventEgressFlowCountThreshold: {
          type: "EventThreshold";
      }
      • type: "EventThreshold"
    • eventEgressMsgRateThreshold: {
          type: "EventThresholdByValue";
      }
      • type: "EventThresholdByValue"
    • eventEndpointCountThreshold: {
          type: "EventThreshold";
      }
      • type: "EventThreshold"
    • eventIngressFlowCountThreshold: {
          type: "EventThreshold";
      }
      • type: "EventThreshold"
    • eventIngressMsgRateThreshold: {
          type: "EventThresholdByValue";
      }
      • type: "EventThresholdByValue"
    • eventLargeMsgThreshold: {
          description: "The threshold, in kilobytes, after which a message is considered to be large for the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1024`.";
          format: "int64";
          type: "number";
      }
      • description: "The threshold, in kilobytes, after which a message is considered to be large for the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1024`."
      • format: "int64"
      • type: "number"
    • eventLogTag: {
          description: "A prefix applied to all published Events in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`.";
          type: "string";
      }
      • description: "A prefix applied to all published Events in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"\"`."
      • type: "string"
    • eventMsgSpoolUsageThreshold: {
          type: "EventThreshold";
      }
      • type: "EventThreshold"
    • eventPublishClientEnabled: {
          description: "Enable or disable Client level Event message publishing. 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 Client level Event message publishing. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`."
      • type: "boolean"
    • eventPublishMsgVpnEnabled: {
          description: "Enable or disable Message VPN level Event message publishing. 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 Message VPN level Event message publishing. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`."
      • type: "boolean"
    • eventPublishSubscriptionMode: {
          type: "Enum";
      }
      • type: "Enum"
    • eventPublishTopicFormatMqttEnabled: {
          description: "Enable or disable Event publish topics in MQTT format. 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 Event publish topics in MQTT format. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`."
      • type: "boolean"
    • eventPublishTopicFormatSmfEnabled: {
          description: "Enable or disable Event publish topics in SMF format. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.";
          type: "boolean";
      }
      • description: "Enable or disable Event publish topics in SMF format. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`."
      • type: "boolean"
    • eventServiceAmqpConnectionCountThreshold: {
          type: "EventThreshold";
      }
      • type: "EventThreshold"
    • eventServiceMqttConnectionCountThreshold: {
          type: "EventThreshold";
      }
      • type: "EventThreshold"
    • eventServiceRestIncomingConnectionCountThreshold: {
          type: "EventThreshold";
      }
      • type: "EventThreshold"
    • eventServiceSmfConnectionCountThreshold: {
          type: "EventThreshold";
      }
      • type: "EventThreshold"
    • eventServiceWebConnectionCountThreshold: {
          type: "EventThreshold";
      }
      • type: "EventThreshold"
    • eventSubscriptionCountThreshold: {
          type: "EventThreshold";
      }
      • type: "EventThreshold"
    • eventTransactedSessionCountThreshold: {
          type: "EventThreshold";
      }
      • type: "EventThreshold"
    • eventTransactionCountThreshold: {
          type: "EventThreshold";
      }
      • type: "EventThreshold"
    • exportSubscriptionsEnabled: {
          description: "Enable or disable the export of subscriptions in the Message VPN to other routers in the network over Neighbor links. 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 export of subscriptions in the Message VPN to other routers in the network over Neighbor links. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`."
      • type: "boolean"
    • jndiEnabled: {
          description: "Enable or disable JNDI access for clients in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.2.";
          type: "boolean";
      }
      • description: "Enable or disable JNDI access for clients in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.2."
      • type: "boolean"
    • maxConnectionCount: {
          description: "The maximum number of client connections to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform.";
          format: "int64";
          type: "number";
      }
      • description: "The maximum number of client connections to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform."
      • format: "int64"
      • type: "number"
    • maxEgressFlowCount: {
          description: "The maximum number of transmit flows that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`.";
          format: "int64";
          type: "number";
      }
      • description: "The maximum number of transmit flows that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`."
      • format: "int64"
      • type: "number"
    • maxEndpointCount: {
          description: "The maximum number of Queues and Topic Endpoints that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`.";
          format: "int64";
          type: "number";
      }
      • description: "The maximum number of Queues and Topic Endpoints that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`."
      • format: "int64"
      • type: "number"
    • maxIngressFlowCount: {
          description: "The maximum number of receive flows that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`.";
          format: "int64";
          type: "number";
      }
      • description: "The maximum number of receive flows that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `1000`."
      • format: "int64"
      • type: "number"
    • maxMsgSpoolUsage: {
          description: "The maximum message spool usage by the Message VPN, in megabytes. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.";
          format: "int64";
          type: "number";
      }
      • description: "The maximum message spool usage by the Message VPN, in megabytes. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`."
      • format: "int64"
      • type: "number"
    • maxSubscriptionCount: {
          description: "The maximum number of local client subscriptions that can be added to the Message VPN. This limit is not enforced when a subscription is added using a management interface, such as CLI or SEMP. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform.";
          format: "int64";
          type: "number";
      }
      • description: "The maximum number of local client subscriptions that can be added to the Message VPN. This limit is not enforced when a subscription is added using a management interface, such as CLI or SEMP. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform."
      • format: "int64"
      • type: "number"
    • maxTransactedSessionCount: {
          description: "The maximum number of transacted sessions that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform.";
          format: "int64";
          type: "number";
      }
      • description: "The maximum number of transacted sessions that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform."
      • format: "int64"
      • type: "number"
    • maxTransactionCount: {
          description: "The maximum number of transactions that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform.";
          format: "int64";
          type: "number";
      }
      • description: "The maximum number of transactions that can be created in the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform."
      • format: "int64"
      • type: "number"
    • mqttRetainMaxMemory: {
          description: "The maximum total memory usage of the MQTT Retain feature for this Message VPN, in MB. If the maximum memory is reached, any arriving retain messages that require more memory are discarded. A value of -1 indicates that the memory is bounded only by the global max memory limit. A value of 0 prevents MQTT Retain from becoming operational. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `-1`. Available since 2.11.";
          format: "int32";
          type: "number";
      }
      • description: "The maximum total memory usage of the MQTT Retain feature for this Message VPN, in MB. If the maximum memory is reached, any arriving retain messages that require more memory are discarded. A value of -1 indicates that the memory is bounded only by the global max memory limit. A value of 0 prevents MQTT Retain from becoming operational. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `-1`. Available since 2.11."
      • format: "int32"
      • type: "number"
    • msgVpnName: {
          description: "The name of the Message VPN.";
          type: "string";
      }
      • description: "The name of the Message VPN."
      • type: "string"
    • replicationAckPropagationIntervalMsgCount: {
          description: "The acknowledgement (ACK) propagation interval for the replication Bridge, in number of replicated messages. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `20`.";
          format: "int64";
          type: "number";
      }
      • description: "The acknowledgement (ACK) propagation interval for the replication Bridge, in number of replicated messages. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `20`."
      • format: "int64"
      • type: "number"
    • replicationBridgeAuthenticationBasicClientUsername: {
          description: "The Client Username the replication Bridge uses to login to the remote Message VPN. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`.";
          type: "string";
      }
      • description: "The Client Username the replication Bridge uses to login to the remote Message VPN. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`."
      • type: "string"
    • replicationBridgeAuthenticationBasicPassword: {
          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 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 via config-sync. The default value is `\"\"`."
      • type: "string"
    • replicationBridgeAuthenticationClientCertContent: {
          description: "The PEM formatted content for the client certificate used by this bridge to login to the Remote Message VPN. It must consist of a private key and between one and three certificates comprising the certificate trust chain. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changing this attribute requires an HTTPS connection. The default value is `\"\"`. Available since 2.9.";
          type: "string";
      }
      • description: "The PEM formatted content for the client certificate used by this bridge to login to the Remote Message VPN. It must consist of a private key and between one and three certificates comprising the certificate trust chain. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changing this attribute requires an HTTPS connection. The default value is `\"\"`. Available since 2.9."
      • type: "string"
    • replicationBridgeAuthenticationClientCertPassword: {
          description: "The password for the client certificate. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changing this attribute requires an HTTPS connection. The default value is `\"\"`. Available since 2.9.";
          type: "string";
      }
      • description: "The password for the client certificate. This attribute is absent from a GET and not updated when absent in a PUT, subject to the exceptions in note 4. Changing this attribute requires an HTTPS connection. The default value is `\"\"`. Available since 2.9."
      • type: "string"
    • replicationBridgeAuthenticationScheme: {
          type: "Enum";
      }
      • type: "Enum"
    • replicationBridgeCompressedDataEnabled: {
          description: "Enable or disable use of compression for the replication Bridge. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.";
          type: "boolean";
      }
      • description: "Enable or disable use of compression for the replication Bridge. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`."
      • type: "boolean"
    • replicationBridgeEgressFlowWindowSize: {
          description: "The size of the window used for guaranteed messages published to the replication Bridge, in messages. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `255`.";
          format: "int64";
          type: "number";
      }
      • description: "The size of the window used for guaranteed messages published to the replication Bridge, in messages. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `255`."
      • format: "int64"
      • type: "number"
    • replicationBridgeRetryDelay: {
          description: "The number of seconds that must pass before retrying the replication Bridge connection. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `3`.";
          format: "int64";
          type: "number";
      }
      • description: "The number of seconds that must pass before retrying the replication Bridge connection. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `3`."
      • format: "int64"
      • type: "number"
    • replicationBridgeTlsEnabled: {
          description: "Enable or disable use of encryption (TLS) for the replication Bridge connection. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.";
          type: "boolean";
      }
      • description: "Enable or disable use of encryption (TLS) for the replication Bridge connection. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`."
      • type: "boolean"
    • replicationBridgeUnidirectionalClientProfileName: {
          description: "The Client Profile for the unidirectional replication Bridge in the Message VPN. It is used only for the TCP parameters. 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 replication Bridge in the Message VPN. It is used only for the TCP parameters. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `\"#client-profile\"`."
      • type: "string"
    • replicationEnabled: {
          description: "Enable or disable replication for the Message VPN. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.";
          type: "boolean";
      }
      • description: "Enable or disable replication for the Message VPN. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`."
      • type: "boolean"
    • replicationEnabledQueueBehavior: {
          type: "Enum";
      }
      • type: "Enum"
    • replicationQueueMaxMsgSpoolUsage: {
          description: "The maximum message spool usage by the replication Bridge local Queue (quota), in megabytes. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `60000`.";
          format: "int64";
          type: "number";
      }
      • description: "The maximum message spool usage by the replication Bridge local Queue (quota), in megabytes. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `60000`."
      • format: "int64"
      • type: "number"
    • replicationQueueRejectMsgToSenderOnDiscardEnabled: {
          description: "Enable or disable whether messages discarded on the replication Bridge local Queue are rejected back to the sender. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.";
          type: "boolean";
      }
      • description: "Enable or disable whether messages discarded on the replication Bridge local Queue are rejected back to the sender. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`."
      • type: "boolean"
    • replicationRejectMsgWhenSyncIneligibleEnabled: {
          description: "Enable or disable whether guaranteed messages published to synchronously replicated Topics are rejected back to the sender when synchronous replication becomes ineligible. 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 whether guaranteed messages published to synchronously replicated Topics are rejected back to the sender when synchronous replication becomes ineligible. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`."
      • type: "boolean"
    • replicationRole: {
          type: "Enum";
      }
      • type: "Enum"
    • replicationTransactionMode: {
          type: "Enum";
      }
      • type: "Enum"
    • restTlsServerCertEnforceTrustedCommonNameEnabled: {
          description: "Enable or disable validation of the Common Name (CN) in the server certificate from the remote REST Consumer. If enabled, the Common Name is checked against the list of Trusted Common Names configured for the REST Consumer. Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Deprecated since 2.17. Common Name validation has been replaced by Server Certificate Name validation.";
          type: "boolean";
      }
      • description: "Enable or disable validation of the Common Name (CN) in the server certificate from the remote REST Consumer. If enabled, the Common Name is checked against the list of Trusted Common Names configured for the REST Consumer. Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Deprecated since 2.17. Common Name validation has been replaced by Server Certificate Name validation."
      • type: "boolean"
    • restTlsServerCertMaxChainDepth: {
          description: "The maximum depth for a REST Consumer server certificate chain. The depth of a chain is defined as the number of signing CA certificates that are present in the chain back to a trusted self-signed root CA certificate. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`.";
          format: "int64";
          type: "number";
      }
      • description: "The maximum depth for a REST Consumer server certificate chain. The depth of a chain is defined as the number of signing CA certificates that are present in the chain back to a trusted self-signed root CA certificate. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `3`."
      • format: "int64"
      • type: "number"
    • restTlsServerCertValidateDateEnabled: {
          description: "Enable or disable validation of the \"Not Before\" and \"Not After\" validity dates in the REST Consumer server certificate. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.";
          type: "boolean";
      }
      • description: "Enable or disable validation of the \"Not Before\" and \"Not After\" validity dates in the REST Consumer server certificate. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`."
      • type: "boolean"
    • restTlsServerCertValidateNameEnabled: {
          description: "Enable or disable the standard TLS authentication mechanism of verifying the name used to connect to the remote REST Consumer. If enabled, the name used to connect to the remote REST Consumer is checked against the names specified in the certificate returned by the remote router. Legacy Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is also enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.17.";
          type: "boolean";
      }
      • description: "Enable or disable the standard TLS authentication mechanism of verifying the name used to connect to the remote REST Consumer. If enabled, the name used to connect to the remote REST Consumer is checked against the names specified in the certificate returned by the remote router. Legacy Common Name validation is not performed if Server Certificate Name Validation is enabled, even if Common Name validation is also enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`. Available since 2.17."
      • type: "boolean"
    • sempOverMsgBusAdminClientEnabled: {
          description: "Enable or disable \"admin client\" SEMP over the message bus commands for the current 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 \"admin client\" SEMP over the message bus commands for the current Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`."
      • type: "boolean"
    • sempOverMsgBusAdminDistributedCacheEnabled: {
          description: "Enable or disable \"admin distributed-cache\" SEMP over the message bus commands for the current 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 \"admin distributed-cache\" SEMP over the message bus commands for the current Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`."
      • type: "boolean"
    • sempOverMsgBusAdminEnabled: {
          description: "Enable or disable \"admin\" SEMP over the message bus commands for the current 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 \"admin\" SEMP over the message bus commands for the current Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`."
      • type: "boolean"
    • sempOverMsgBusEnabled: {
          description: "Enable or disable SEMP over the message bus for the current Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.";
          type: "boolean";
      }
      • description: "Enable or disable SEMP over the message bus for the current Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`."
      • type: "boolean"
    • sempOverMsgBusShowEnabled: {
          description: "Enable or disable \"show\" SEMP over the message bus commands for the current 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 \"show\" SEMP over the message bus commands for the current Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`."
      • type: "boolean"
    • serviceAmqpMaxConnectionCount: {
          description: "The maximum number of AMQP client connections that can be simultaneously connected to the Message VPN. This value may be higher than supported by the platform. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform. Available since 2.7.";
          format: "int64";
          type: "number";
      }
      • description: "The maximum number of AMQP client connections that can be simultaneously connected to the Message VPN. This value may be higher than supported by the platform. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform. Available since 2.7."
      • format: "int64"
      • type: "number"
    • serviceAmqpPlainTextEnabled: {
          description: "Enable or disable the plain-text AMQP service in the Message VPN. Disabling causes clients connected to the corresponding listen-port to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.7.";
          type: "boolean";
      }
      • description: "Enable or disable the plain-text AMQP service in the Message VPN. Disabling causes clients connected to the corresponding listen-port to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.7."
      • type: "boolean"
    • serviceAmqpPlainTextListenPort: {
          description: "The port number for plain-text AMQP clients that connect to the Message VPN. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.7.";
          format: "int64";
          type: "number";
      }
      • description: "The port number for plain-text AMQP clients that connect to the Message VPN. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.7."
      • format: "int64"
      • type: "number"
    • serviceAmqpTlsEnabled: {
          description: "Enable or disable the use of encryption (TLS) for the AMQP service in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.7.";
          type: "boolean";
      }
      • description: "Enable or disable the use of encryption (TLS) for the AMQP service in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.7."
      • type: "boolean"
    • serviceAmqpTlsListenPort: {
          description: "The port number for AMQP clients that connect to the Message VPN over TLS. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.7.";
          format: "int64";
          type: "number";
      }
      • description: "The port number for AMQP clients that connect to the Message VPN over TLS. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.7."
      • format: "int64"
      • type: "number"
    • serviceMqttAuthenticationClientCertRequest: {
          type: "Enum";
      }
      • type: "Enum"
    • serviceMqttMaxConnectionCount: {
          description: "The maximum number of MQTT client connections that can be simultaneously connected to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform. Available since 2.1.";
          format: "int64";
          type: "number";
      }
      • description: "The maximum number of MQTT client connections that can be simultaneously connected to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform. Available since 2.1."
      • format: "int64"
      • type: "number"
    • serviceMqttPlainTextEnabled: {
          description: "Enable or disable the plain-text MQTT service in the Message VPN. Disabling causes clients currently connected to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.1.";
          type: "boolean";
      }
      • description: "Enable or disable the plain-text MQTT service in the Message VPN. Disabling causes clients currently connected to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.1."
      • type: "boolean"
    • serviceMqttPlainTextListenPort: {
          description: "The port number for plain-text MQTT clients that connect to the Message VPN. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.1.";
          format: "int64";
          type: "number";
      }
      • description: "The port number for plain-text MQTT clients that connect to the Message VPN. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.1."
      • format: "int64"
      • type: "number"
    • serviceMqttTlsEnabled: {
          description: "Enable or disable the use of encryption (TLS) for the MQTT service in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.1.";
          type: "boolean";
      }
      • description: "Enable or disable the use of encryption (TLS) for the MQTT service in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.1."
      • type: "boolean"
    • serviceMqttTlsListenPort: {
          description: "The port number for MQTT clients that connect to the Message VPN over TLS. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.1.";
          format: "int64";
          type: "number";
      }
      • description: "The port number for MQTT clients that connect to the Message VPN over TLS. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.1."
      • format: "int64"
      • type: "number"
    • serviceMqttTlsWebSocketEnabled: {
          description: "Enable or disable the use of encrypted WebSocket (WebSocket over TLS) for the MQTT service in the Message VPN. Disabling causes clients currently connected by encrypted WebSocket to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.1.";
          type: "boolean";
      }
      • description: "Enable or disable the use of encrypted WebSocket (WebSocket over TLS) for the MQTT service in the Message VPN. Disabling causes clients currently connected by encrypted WebSocket to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.1."
      • type: "boolean"
    • serviceMqttTlsWebSocketListenPort: {
          description: "The port number for MQTT clients that connect to the Message VPN using WebSocket over TLS. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.1.";
          format: "int64";
          type: "number";
      }
      • description: "The port number for MQTT clients that connect to the Message VPN using WebSocket over TLS. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.1."
      • format: "int64"
      • type: "number"
    • serviceMqttWebSocketEnabled: {
          description: "Enable or disable the use of WebSocket for the MQTT service in the Message VPN. Disabling causes clients currently connected by WebSocket to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.1.";
          type: "boolean";
      }
      • description: "Enable or disable the use of WebSocket for the MQTT service in the Message VPN. Disabling causes clients currently connected by WebSocket to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`. Available since 2.1."
      • type: "boolean"
    • serviceMqttWebSocketListenPort: {
          description: "The port number for plain-text MQTT clients that connect to the Message VPN using WebSocket. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.1.";
          format: "int64";
          type: "number";
      }
      • description: "The port number for plain-text MQTT clients that connect to the Message VPN using WebSocket. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`. Available since 2.1."
      • format: "int64"
      • type: "number"
    • serviceRestIncomingAuthenticationClientCertRequest: {
          type: "Enum";
      }
      • type: "Enum"
    • serviceRestIncomingAuthorizationHeaderHandling: {
          type: "Enum";
      }
      • type: "Enum"
    • serviceRestIncomingMaxConnectionCount: {
          description: "The maximum number of REST incoming client connections that can be simultaneously connected to the Message VPN. This value may be higher than supported by the platform. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform.";
          format: "int64";
          type: "number";
      }
      • description: "The maximum number of REST incoming client connections that can be simultaneously connected to the Message VPN. This value may be higher than supported by the platform. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform."
      • format: "int64"
      • type: "number"
    • serviceRestIncomingPlainTextEnabled: {
          description: "Enable or disable the plain-text REST service for incoming clients in the Message VPN. Disabling causes clients currently connected to be disconnected. 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 plain-text REST service for incoming clients in the Message VPN. Disabling causes clients currently connected to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`."
      • type: "boolean"
    • serviceRestIncomingPlainTextListenPort: {
          description: "The port number for incoming plain-text REST clients that connect to the Message VPN. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.";
          format: "int64";
          type: "number";
      }
      • description: "The port number for incoming plain-text REST clients that connect to the Message VPN. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`."
      • format: "int64"
      • type: "number"
    • serviceRestIncomingTlsEnabled: {
          description: "Enable or disable the use of encryption (TLS) for the REST service for incoming clients in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. 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 use of encryption (TLS) for the REST service for incoming clients in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`."
      • type: "boolean"
    • serviceRestIncomingTlsListenPort: {
          description: "The port number for incoming REST clients that connect to the Message VPN over TLS. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`.";
          format: "int64";
          type: "number";
      }
      • description: "The port number for incoming REST clients that connect to the Message VPN over TLS. The port must be unique across the message backbone. A value of 0 means that the listen-port is unassigned and cannot be enabled. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `0`."
      • format: "int64"
      • type: "number"
    • serviceRestMode: {
          type: "Enum";
      }
      • type: "Enum"
    • serviceRestOutgoingMaxConnectionCount: {
          description: "The maximum number of REST Consumer (outgoing) client connections that can be simultaneously connected to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform.";
          format: "int64";
          type: "number";
      }
      • description: "The maximum number of REST Consumer (outgoing) client connections that can be simultaneously connected to the Message VPN. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform."
      • format: "int64"
      • type: "number"
    • serviceSmfMaxConnectionCount: {
          description: "The maximum number of SMF client connections that can be simultaneously connected to the Message VPN. This value may be higher than supported by the platform. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform.";
          format: "int64";
          type: "number";
      }
      • description: "The maximum number of SMF client connections that can be simultaneously connected to the Message VPN. This value may be higher than supported by the platform. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default varies by platform."
      • format: "int64"
      • type: "number"
    • serviceSmfPlainTextEnabled: {
          description: "Enable or disable the plain-text SMF service in the Message VPN. Disabling causes clients currently connected to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.";
          type: "boolean";
      }
      • description: "Enable or disable the plain-text SMF service in the Message VPN. Disabling causes clients currently connected to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`."
      • type: "boolean"
    • serviceSmfTlsEnabled: {
          description: "Enable or disable the use of encryption (TLS) for the SMF service in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.";
          type: "boolean";
      }
      • description: "Enable or disable the use of encryption (TLS) for the SMF service in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`."
      • type: "boolean"
    • serviceWebAuthenticationClientCertRequest: {
          type: "Enum";
      }
      • type: "Enum"
    • serviceWebMaxConnectionCount: {
          description: "The maximum number of Web Transport client connections that can be simultaneously connected to the Message VPN. This value may be higher than supported by the platform. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform.";
          format: "int64";
          type: "number";
      }
      • description: "The maximum number of Web Transport client connections that can be simultaneously connected to the Message VPN. This value may be higher than supported by the platform. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default is the maximum value supported by the platform."
      • format: "int64"
      • type: "number"
    • serviceWebPlainTextEnabled: {
          description: "Enable or disable the plain-text Web Transport service in the Message VPN. Disabling causes clients currently connected to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.";
          type: "boolean";
      }
      • description: "Enable or disable the plain-text Web Transport service in the Message VPN. Disabling causes clients currently connected to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`."
      • type: "boolean"
    • serviceWebTlsEnabled: {
          description: "Enable or disable the use of TLS for the Web Transport service in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`.";
          type: "boolean";
      }
      • description: "Enable or disable the use of TLS for the Web Transport service in the Message VPN. Disabling causes clients currently connected over TLS to be disconnected. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `true`."
      • type: "boolean"
    • tlsAllowDowngradeToPlainTextEnabled: {
          description: "Enable or disable the allowing of TLS SMF clients to downgrade their connections to plain-text connections. Changing this will not affect existing connections. 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 allowing of TLS SMF clients to downgrade their connections to plain-text connections. Changing this will not affect existing connections. Changes to this attribute are synchronized to HA mates and replication sites via config-sync. The default value is `false`."
      • type: "boolean"

Settings

Member Visibility

Theme