Variable $BrokerConst

Type declaration

• properties: {
      authClientCertRevocationCheckMode: {
          type: "Enum";
      };
      configSyncAuthenticationClientCertMaxChainDepth: {
          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. The default value is `3`. Available since 2.22.";
          format: "int64";
          type: "number";
      };
      configSyncAuthenticationClientCertValidateDateEnabled: {
          description: "Enable or disable validation of the \"Not Before\" and \"Not After\" validity dates in the authentication certificate(s). The default value is `true`. Available since 2.22.";
          type: "boolean";
      };
      configSyncClientProfileTcpInitialCongestionWindow: {
          description: "The TCP initial congestion window size for Config Sync clients, in multiples of the TCP Maximum Segment Size (MSS). Changing the value from its default of 2 results in non-compliance with RFC 2581. Contact support before changing this value. The default value is `2`. Available since 2.22.";
          format: "int64";
          type: "number";
      };
      configSyncClientProfileTcpKeepaliveCount: {
          description: "The number of TCP keepalive retransmissions to a client using the Client Profile before declaring that it is not available. The default value is `5`. Available since 2.22.";
          format: "int64";
          type: "number";
      };
      configSyncClientProfileTcpKeepaliveIdle: {
          description: "The amount of time a client connection using the Client Profile must remain idle before TCP begins sending keepalive probes, in seconds. The default value is `3`. Available since 2.22.";
          format: "int64";
          type: "number";
      };
      configSyncClientProfileTcpKeepaliveInterval: {
          description: "The amount of time between TCP keepalive retransmissions to a client using the Client Profile when no acknowledgement is received, in seconds. The default value is `1`. Available since 2.22.";
          format: "int64";
          type: "number";
      };
      configSyncClientProfileTcpMaxWindow: {
          description: "The TCP maximum window size for clients using the Client Profile, in kilobytes. Changes are applied to all existing connections. The default value is `256`. Available since 2.22.";
          format: "int64";
          type: "number";
      };
      configSyncClientProfileTcpMss: {
          description: "The TCP maximum segment size for clients using the Client Profile, in bytes. Changes are applied to all existing connections. The default value is `1460`. Available since 2.22.";
          format: "int64";
          type: "number";
      };
      configSyncEnabled: {
          description: "Enable or disable configuration synchronization for High Availability or Disaster Recovery. The default value is `false`. Available since 2.22.";
          type: "boolean";
      };
      configSyncSynchronizeUsernameEnabled: {
          description: "Enable or disable the synchronizing of usernames within High Availability groups. The transition from not synchronizing to synchronizing will cause the High Availability mate to fall out of sync. Recommendation: leave this as enabled. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. Available since 2.22.";
          type: "boolean";
      };
      configSyncTlsEnabled: {
          description: "Enable or disable the use of TLS encryption of the configuration synchronization communications between brokers in High Availability groups and/or Disaster Recovery sites. The default value is `false`. Available since 2.22.";
          type: "boolean";
      };
      guaranteedMsgingDefragmentationScheduleDayList: {
          description: "The days of the week to schedule defragmentation runs, specified as \"daily\" or as a comma-separated list of days. Days must be specified as \"Sun\", \"Mon\", \"Tue\", \"Wed\", \"Thu\", \"Fri, or \"Sat\", with no spaces, and in sorted order from Sunday to Saturday. Please note \"Sun,Mon,Tue,Wed,Thu,Fri,Sat\" is not allowed, use \"daily\" instead. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"daily\"`. Available since 2.25.";
          type: "string";
      };
      guaranteedMsgingDefragmentationScheduleEnabled: {
          description: "Enable or disable schedule-based defragmentation of Guaranteed Messaging spool files. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.25.";
          type: "boolean";
      };
      guaranteedMsgingDefragmentationScheduleTimeList: {
          description: "The times of the day to schedule defragmentation runs, specified as \"hourly\" or as a comma-separated list of 24-hour times in the form hh:mm, or h:mm. There must be no spaces, and times (up to 4) must be in sorted order from 0:00 to 23:59. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"0:00\"`. Available since 2.25.";
          type: "string";
      };
      guaranteedMsgingDefragmentationThresholdEnabled: {
          description: "Enable or disable threshold-based defragmentation of Guaranteed Messaging spool files. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.25.";
          type: "boolean";
      };
      guaranteedMsgingDefragmentationThresholdFragmentationPercentage: {
          description: "Percentage of spool fragmentation needed to trigger defragmentation run. The minimum value allowed is 30%. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `50`. Available since 2.25.";
          format: "int64";
          type: "number";
      };
      guaranteedMsgingDefragmentationThresholdMinInterval: {
          description: "Minimum interval of time (in minutes) between defragmentation runs triggered by thresholds. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `15`. Available since 2.25.";
          format: "int64";
          type: "number";
      };
      guaranteedMsgingDefragmentationThresholdUsagePercentage: {
          description: "Percentage of spool usage needed to trigger defragmentation run. The minimum value allowed is 30%. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `50`. Available since 2.25.";
          format: "int64";
          type: "number";
      };
      guaranteedMsgingEnabled: {
          description: "Enable or disable Guaranteed Messaging. The default value is `false`. Available since 2.18.";
          type: "boolean";
      };
      guaranteedMsgingEventCacheUsageThreshold: {
          type: "EventThreshold";
      };
      guaranteedMsgingEventDeliveredUnackedThreshold: {
          type: "EventThresholdByPercent";
      };
      guaranteedMsgingEventDiskUsageThreshold: {
          type: "EventThresholdByPercent";
      };
      guaranteedMsgingEventEgressFlowCountThreshold: {
          type: "EventThreshold";
      };
      guaranteedMsgingEventEndpointCountThreshold: {
          type: "EventThreshold";
      };
      guaranteedMsgingEventIngressFlowCountThreshold: {
          type: "EventThreshold";
      };
      guaranteedMsgingEventMsgCountThreshold: {
          type: "EventThresholdByPercent";
      };
      guaranteedMsgingEventMsgSpoolFileCountThreshold: {
          type: "EventThresholdByPercent";
      };
      guaranteedMsgingEventMsgSpoolUsageThreshold: {
          type: "EventThreshold";
      };
      guaranteedMsgingEventTransactedSessionCountThreshold: {
          type: "EventThreshold";
      };
      guaranteedMsgingEventTransactedSessionResourceCountThreshold: {
          type: "EventThresholdByPercent";
      };
      guaranteedMsgingEventTransactionCountThreshold: {
          type: "EventThreshold";
      };
      guaranteedMsgingMaxCacheUsage: {
          description: "Guaranteed messaging cache usage limit. Expressed as a maximum percentage of the NAB's egress queueing. resources that the guaranteed message cache is allowed to use. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `10`. Available since 2.18.";
          format: "int32";
          type: "number";
      };
      guaranteedMsgingMaxMsgSpoolUsage: {
          description: "The maximum total message spool usage allowed across all VPNs on this broker, in megabytes. Recommendation: the maximum value should be less than 90% of the disk space allocated for the guaranteed message spool. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1500`. Available since 2.18.";
          format: "int64";
          type: "number";
      };
      guaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout: {
          description: "The maximum time, in milliseconds, that can be tolerated for remote acknowledgement of synchronization messages before which the remote system will be considered out of sync. The default value is `10000`. Available since 2.18.";
          format: "int64";
          type: "number";
      };
      guaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout: {
          description: "The maximum time, in milliseconds, that can be tolerated for remote disk writes before which the remote system will be considered out of sync. The default value is `10000`. Available since 2.18.";
          format: "int64";
          type: "number";
      };
      guaranteedMsgingTransactionReplicationCompatibilityMode: {
          type: "Enum";
      };
      oauthProfileDefault: {
          description: "The default OAuth profile for OAuth authenticated SEMP requests. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. Available since 2.24.";
          type: "string";
      };
      serviceAmqpEnabled: {
          description: "Enable or disable the AMQP service. When disabled new AMQP Clients may not connect through the global or per-VPN AMQP listen-ports, and all currently connected AMQP Clients are immediately disconnected. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.17.";
          type: "boolean";
      };
      serviceAmqpTlsListenPort: {
          description: "TCP port number that AMQP clients can use to connect to the broker using raw TCP over TLS. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `0`. Available since 2.17.";
          format: "int64";
          type: "number";
      };
      serviceEventConnectionCountThreshold: {
          type: "EventThreshold";
      };
      serviceHealthCheckEnabled: {
          description: "Enable or disable the health-check service. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.17.";
          type: "boolean";
      };
      serviceHealthCheckListenPort: {
          description: "The port number for the health-check service. The port must be unique across the message backbone. The health-check service must be disabled to change the port. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `5550`. Available since 2.17.";
          format: "int64";
          type: "number";
      };
      serviceMateLinkEnabled: {
          description: "Enable or disable the mate-link service. The default value is `true`. Available since 2.17.";
          type: "boolean";
      };
      serviceMateLinkListenPort: {
          description: "The port number for the mate-link service. The port must be unique across the message backbone. The mate-link service must be disabled to change the port. The default value is `8741`. Available since 2.17.";
          format: "int64";
          type: "number";
      };
      serviceMqttEnabled: {
          description: "Enable or disable the MQTT service. When disabled new MQTT Clients may not connect through the per-VPN MQTT listen-ports, and all currently connected MQTT Clients are immediately disconnected. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.17.";
          type: "boolean";
      };
      serviceMsgBackboneEnabled: {
          description: "Enable or disable the msg-backbone service. When disabled new Clients may not connect through global or per-VPN listen-ports, and all currently connected Clients are immediately disconnected. The default value is `true`. Available since 2.17.";
          type: "boolean";
      };
      serviceRedundancyEnabled: {
          description: "Enable or disable the redundancy service. The default value is `true`. Available since 2.17.";
          type: "boolean";
      };
      serviceRedundancyFirstListenPort: {
          description: "The first listen-port used for the redundancy service. Redundancy uses this port and the subsequent 2 ports. These port must be unique across the message backbone. The redundancy service must be disabled to change this port. The default value is `8300`. Available since 2.17.";
          format: "int64";
          type: "number";
      };
      serviceRestEventOutgoingConnectionCountThreshold: {
          type: "EventThreshold";
      };
      serviceRestIncomingEnabled: {
          description: "Enable or disable the REST service incoming connections on the router. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.17.";
          type: "boolean";
      };
      serviceRestOutgoingEnabled: {
          description: "Enable or disable the REST service outgoing connections on the router. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.17.";
          type: "boolean";
      };
      serviceSempCorsAllowAnyHostEnabled: {
          description: "Enable or disable cross origin resource requests for the SEMP service. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. Available since 2.24.";
          type: "boolean";
      };
      serviceSempLegacyTimeoutEnabled: {
          description: "Enable or disable extended SEMP timeouts for paged GETs. When a request times out, it returns the current page of content, even if the page is not full. When enabled, the timeout is 60 seconds. When disabled, the timeout is 5 seconds. The recommended setting is disabled (no legacy-timeout). This parameter is intended as a temporary workaround to be used until SEMP clients can handle short pages. This setting will be removed in a future release. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.18.";
          type: "boolean";
      };
      serviceSempPlainTextEnabled: {
          description: "Enable or disable plain-text SEMP service. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. Available since 2.17.";
          type: "boolean";
      };
      serviceSempPlainTextListenPort: {
          description: "The TCP port for plain-text SEMP client connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `80`. Available since 2.17.";
          format: "int64";
          type: "number";
      };
      serviceSempSessionIdleTimeout: {
          description: "The session idle timeout, in minutes. Sessions will be invalidated if there is no activity in this period of time. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `15`. Available since 2.21.";
          format: "int32";
          type: "number";
      };
      serviceSempSessionMaxLifetime: {
          description: "The maximum lifetime of a session, in minutes. Sessions will be invalidated after this period of time, regardless of activity. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `43200`. Available since 2.21.";
          format: "int32";
          type: "number";
      };
      serviceSempTlsEnabled: {
          description: "Enable or disable TLS SEMP service. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. Available since 2.17.";
          type: "boolean";
      };
      serviceSempTlsListenPort: {
          description: "The TCP port for TLS SEMP client connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1943`. Available since 2.17.";
          format: "int64";
          type: "number";
      };
      serviceSmfCompressionListenPort: {
          description: "TCP port number that SMF clients can use to connect to the broker using raw compression TCP. The default value is `55003`. Available since 2.17.";
          format: "int64";
          type: "number";
      };
      serviceSmfEnabled: {
          description: "Enable or disable the SMF service. When disabled new SMF Clients may not connect through the global listen-ports, and all currently connected SMF Clients are immediately disconnected. The default value is `true`. Available since 2.17.";
          type: "boolean";
      };
      serviceSmfEventConnectionCountThreshold: {
          type: "EventThreshold";
      };
      serviceSmfPlainTextListenPort: {
          description: "TCP port number that SMF clients can use to connect to the broker using raw TCP. The default value is `55555`. Available since 2.17.";
          format: "int64";
          type: "number";
      };
      serviceSmfRoutingControlListenPort: {
          description: "TCP port number that SMF clients can use to connect to the broker using raw routing control TCP. The default value is `55556`. Available since 2.17.";
          format: "int64";
          type: "number";
      };
      serviceSmfTlsListenPort: {
          description: "TCP port number that SMF clients can use to connect to the broker using raw TCP over TLS. The default value is `55443`. Available since 2.17.";
          format: "int64";
          type: "number";
      };
      serviceTlsEventConnectionCountThreshold: {
          type: "EventThreshold";
      };
      serviceWebTransportEnabled: {
          description: "Enable or disable the web-transport service. When disabled new web-transport Clients may not connect through the global listen-ports, and all currently connected web-transport Clients are immediately disconnected. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.17.";
          type: "boolean";
      };
      serviceWebTransportPlainTextListenPort: {
          description: "The TCP port for plain-text WEB client connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `8008`. Available since 2.17.";
          format: "int64";
          type: "number";
      };
      serviceWebTransportTlsListenPort: {
          description: "The TCP port for TLS WEB client connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1443`. Available since 2.17.";
          format: "int64";
          type: "number";
      };
      serviceWebTransportWebUrlSuffix: {
          description: "Used to specify the Web URL suffix that will be used by Web clients when communicating with the broker. The default value is `\"\"`. Available since 2.17.";
          type: "string";
      };
      tlsBlockVersion11Enabled: {
          description: "Enable or disable the blocking of TLS version 1.1 connections. When blocked, all existing incoming and outgoing TLS 1.1 connections with Clients, SEMP users, and LDAP servers remain connected while new connections are blocked. Note that support for TLS 1.1 will eventually be discontinued, at which time TLS 1.1 connections will be blocked regardless of this setting. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.";
          type: "boolean";
      };
      tlsCipherSuiteManagementList: {
          description: "The colon-separated list of cipher suites used for TLS management connections (e.g. SEMP, LDAP). The value \"default\" implies all supported suites ordered from most secure to least secure. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"default\"`.";
          type: "string";
      };
      tlsCipherSuiteMsgBackboneList: {
          description: "The colon-separated list of cipher suites used for TLS data connections (e.g. client pub/sub). The value \"default\" implies all supported suites ordered from most secure to least secure. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"default\"`.";
          type: "string";
      };
      tlsCipherSuiteSecureShellList: {
          description: "The colon-separated list of cipher suites used for TLS secure shell connections (e.g. SSH, SFTP, SCP). The value \"default\" implies all supported suites ordered from most secure to least secure. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"default\"`.";
          type: "string";
      };
      tlsCrimeExploitProtectionEnabled: {
          description: "Enable or disable protection against the CRIME exploit. When enabled, TLS+compressed messaging performance is degraded. This protection should only be disabled if sufficient ACL and authentication features are being employed such that a potential attacker does not have sufficient access to trigger the exploit. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`.";
          type: "boolean";
      };
      tlsServerCertContent: {
          description: "The PEM formatted content for the server certificate used for TLS connections. 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 `\"\"`.";
          type: "string";
      };
      tlsServerCertPassword: {
          description: "The password for the server certificate used for TLS connections. 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 `\"\"`.";
          type: "string";
      };
      tlsStandardDomainCertificateAuthoritiesEnabled: {
          description: "Enable or disable the standard domain certificate authority list. The default value is `true`. Available since 2.19.";
          type: "boolean";
      };
      tlsTicketLifetime: {
          description: "The TLS ticket lifetime in seconds. When a client connects with TLS, a session with a session ticket is created using the TLS ticket lifetime which determines how long the client has to resume the session. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `86400`.";
          format: "int32";
          type: "number";
      };
      webManagerAllowUnencryptedWizardsEnabled: {
          description: "Enable or disable the use of unencrypted wizards in the Web-based Manager UI. This setting should be left at its default on all production systems or other systems that need to be secure. Enabling this option will permit the broker to forward plain-text data to other brokers, making important information or credentials available for snooping. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.28.";
          type: "boolean";
      };
      webManagerCustomization: {
          description: "Reserved for internal use by Solace. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. Available since 2.25.";
          type: "string";
      };
      webManagerRedirectHttpEnabled: {
          description: "Enable or disable redirection of HTTP requests for the broker manager to HTTPS. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. Available since 2.24.";
          type: "boolean";
      };
      webManagerRedirectHttpOverrideTlsPort: {
          description: "The HTTPS port that HTTP requests will be redirected towards in a HTTP 301 redirect response. Zero is a special value that means use the value specified for the SEMP TLS port value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `0`. Available since 2.24.";
          format: "int32";
          type: "number";
      };
  }

  • authClientCertRevocationCheckMode: {
        type: "Enum";
    }

    • type: "Enum"

  • configSyncAuthenticationClientCertMaxChainDepth: {
        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. The default value is `3`. Available since 2.22.";
        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. The default value is `3`. Available since 2.22."

    • format: "int64"

    • type: "number"

  • configSyncAuthenticationClientCertValidateDateEnabled: {
        description: "Enable or disable validation of the \"Not Before\" and \"Not After\" validity dates in the authentication certificate(s). The default value is `true`. Available since 2.22.";
        type: "boolean";
    }

    • description: "Enable or disable validation of the \"Not Before\" and \"Not After\" validity dates in the authentication certificate(s). The default value is `true`. Available since 2.22."

    • type: "boolean"

  • configSyncClientProfileTcpInitialCongestionWindow: {
        description: "The TCP initial congestion window size for Config Sync clients, in multiples of the TCP Maximum Segment Size (MSS). Changing the value from its default of 2 results in non-compliance with RFC 2581. Contact support before changing this value. The default value is `2`. Available since 2.22.";
        format: "int64";
        type: "number";
    }

    • description: "The TCP initial congestion window size for Config Sync clients, in multiples of the TCP Maximum Segment Size (MSS). Changing the value from its default of 2 results in non-compliance with RFC 2581. Contact support before changing this value. The default value is `2`. Available since 2.22."

    • format: "int64"

    • type: "number"

  • configSyncClientProfileTcpKeepaliveCount: {
        description: "The number of TCP keepalive retransmissions to a client using the Client Profile before declaring that it is not available. The default value is `5`. Available since 2.22.";
        format: "int64";
        type: "number";
    }

    • description: "The number of TCP keepalive retransmissions to a client using the Client Profile before declaring that it is not available. The default value is `5`. Available since 2.22."

    • format: "int64"

    • type: "number"

  • configSyncClientProfileTcpKeepaliveIdle: {
        description: "The amount of time a client connection using the Client Profile must remain idle before TCP begins sending keepalive probes, in seconds. The default value is `3`. Available since 2.22.";
        format: "int64";
        type: "number";
    }

    • description: "The amount of time a client connection using the Client Profile must remain idle before TCP begins sending keepalive probes, in seconds. The default value is `3`. Available since 2.22."

    • format: "int64"

    • type: "number"

  • configSyncClientProfileTcpKeepaliveInterval: {
        description: "The amount of time between TCP keepalive retransmissions to a client using the Client Profile when no acknowledgement is received, in seconds. The default value is `1`. Available since 2.22.";
        format: "int64";
        type: "number";
    }

    • description: "The amount of time between TCP keepalive retransmissions to a client using the Client Profile when no acknowledgement is received, in seconds. The default value is `1`. Available since 2.22."

    • format: "int64"

    • type: "number"

  • configSyncClientProfileTcpMaxWindow: {
        description: "The TCP maximum window size for clients using the Client Profile, in kilobytes. Changes are applied to all existing connections. The default value is `256`. Available since 2.22.";
        format: "int64";
        type: "number";
    }

    • description: "The TCP maximum window size for clients using the Client Profile, in kilobytes. Changes are applied to all existing connections. The default value is `256`. Available since 2.22."

    • format: "int64"

    • type: "number"

  • configSyncClientProfileTcpMss: {
        description: "The TCP maximum segment size for clients using the Client Profile, in bytes. Changes are applied to all existing connections. The default value is `1460`. Available since 2.22.";
        format: "int64";
        type: "number";
    }

    • description: "The TCP maximum segment size for clients using the Client Profile, in bytes. Changes are applied to all existing connections. The default value is `1460`. Available since 2.22."

    • format: "int64"

    • type: "number"

  • configSyncEnabled: {
        description: "Enable or disable configuration synchronization for High Availability or Disaster Recovery. The default value is `false`. Available since 2.22.";
        type: "boolean";
    }

    • description: "Enable or disable configuration synchronization for High Availability or Disaster Recovery. The default value is `false`. Available since 2.22."

    • type: "boolean"

  • configSyncSynchronizeUsernameEnabled: {
        description: "Enable or disable the synchronizing of usernames within High Availability groups. The transition from not synchronizing to synchronizing will cause the High Availability mate to fall out of sync. Recommendation: leave this as enabled. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. Available since 2.22.";
        type: "boolean";
    }

    • description: "Enable or disable the synchronizing of usernames within High Availability groups. The transition from not synchronizing to synchronizing will cause the High Availability mate to fall out of sync. Recommendation: leave this as enabled. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. Available since 2.22."

    • type: "boolean"

  • configSyncTlsEnabled: {
        description: "Enable or disable the use of TLS encryption of the configuration synchronization communications between brokers in High Availability groups and/or Disaster Recovery sites. The default value is `false`. Available since 2.22.";
        type: "boolean";
    }

    • description: "Enable or disable the use of TLS encryption of the configuration synchronization communications between brokers in High Availability groups and/or Disaster Recovery sites. The default value is `false`. Available since 2.22."

    • type: "boolean"

  • guaranteedMsgingDefragmentationScheduleDayList: {
        description: "The days of the week to schedule defragmentation runs, specified as \"daily\" or as a comma-separated list of days. Days must be specified as \"Sun\", \"Mon\", \"Tue\", \"Wed\", \"Thu\", \"Fri, or \"Sat\", with no spaces, and in sorted order from Sunday to Saturday. Please note \"Sun,Mon,Tue,Wed,Thu,Fri,Sat\" is not allowed, use \"daily\" instead. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"daily\"`. Available since 2.25.";
        type: "string";
    }

    • description: "The days of the week to schedule defragmentation runs, specified as \"daily\" or as a comma-separated list of days. Days must be specified as \"Sun\", \"Mon\", \"Tue\", \"Wed\", \"Thu\", \"Fri, or \"Sat\", with no spaces, and in sorted order from Sunday to Saturday. Please note \"Sun,Mon,Tue,Wed,Thu,Fri,Sat\" is not allowed, use \"daily\" instead. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"daily\"`. Available since 2.25."

    • type: "string"

  • guaranteedMsgingDefragmentationScheduleEnabled: {
        description: "Enable or disable schedule-based defragmentation of Guaranteed Messaging spool files. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.25.";
        type: "boolean";
    }

    • description: "Enable or disable schedule-based defragmentation of Guaranteed Messaging spool files. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.25."

    • type: "boolean"

  • guaranteedMsgingDefragmentationScheduleTimeList: {
        description: "The times of the day to schedule defragmentation runs, specified as \"hourly\" or as a comma-separated list of 24-hour times in the form hh:mm, or h:mm. There must be no spaces, and times (up to 4) must be in sorted order from 0:00 to 23:59. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"0:00\"`. Available since 2.25.";
        type: "string";
    }

    • description: "The times of the day to schedule defragmentation runs, specified as \"hourly\" or as a comma-separated list of 24-hour times in the form hh:mm, or h:mm. There must be no spaces, and times (up to 4) must be in sorted order from 0:00 to 23:59. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"0:00\"`. Available since 2.25."

    • type: "string"

  • guaranteedMsgingDefragmentationThresholdEnabled: {
        description: "Enable or disable threshold-based defragmentation of Guaranteed Messaging spool files. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.25.";
        type: "boolean";
    }

    • description: "Enable or disable threshold-based defragmentation of Guaranteed Messaging spool files. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.25."

    • type: "boolean"

  • guaranteedMsgingDefragmentationThresholdFragmentationPercentage: {
        description: "Percentage of spool fragmentation needed to trigger defragmentation run. The minimum value allowed is 30%. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `50`. Available since 2.25.";
        format: "int64";
        type: "number";
    }

    • description: "Percentage of spool fragmentation needed to trigger defragmentation run. The minimum value allowed is 30%. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `50`. Available since 2.25."

    • format: "int64"

    • type: "number"

  • guaranteedMsgingDefragmentationThresholdMinInterval: {
        description: "Minimum interval of time (in minutes) between defragmentation runs triggered by thresholds. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `15`. Available since 2.25.";
        format: "int64";
        type: "number";
    }

    • description: "Minimum interval of time (in minutes) between defragmentation runs triggered by thresholds. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `15`. Available since 2.25."

    • format: "int64"

    • type: "number"

  • guaranteedMsgingDefragmentationThresholdUsagePercentage: {
        description: "Percentage of spool usage needed to trigger defragmentation run. The minimum value allowed is 30%. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `50`. Available since 2.25.";
        format: "int64";
        type: "number";
    }

    • description: "Percentage of spool usage needed to trigger defragmentation run. The minimum value allowed is 30%. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `50`. Available since 2.25."

    • format: "int64"

    • type: "number"

  • guaranteedMsgingEnabled: {
        description: "Enable or disable Guaranteed Messaging. The default value is `false`. Available since 2.18.";
        type: "boolean";
    }

    • description: "Enable or disable Guaranteed Messaging. The default value is `false`. Available since 2.18."

    • type: "boolean"

  • guaranteedMsgingEventCacheUsageThreshold: {
        type: "EventThreshold";
    }

    • type: "EventThreshold"

  • guaranteedMsgingEventDeliveredUnackedThreshold: {
        type: "EventThresholdByPercent";
    }

    • type: "EventThresholdByPercent"

  • guaranteedMsgingEventDiskUsageThreshold: {
        type: "EventThresholdByPercent";
    }

    • type: "EventThresholdByPercent"

  • guaranteedMsgingEventEgressFlowCountThreshold: {
        type: "EventThreshold";
    }

    • type: "EventThreshold"

  • guaranteedMsgingEventEndpointCountThreshold: {
        type: "EventThreshold";
    }

    • type: "EventThreshold"

  • guaranteedMsgingEventIngressFlowCountThreshold: {
        type: "EventThreshold";
    }

    • type: "EventThreshold"

  • guaranteedMsgingEventMsgCountThreshold: {
        type: "EventThresholdByPercent";
    }

    • type: "EventThresholdByPercent"

  • guaranteedMsgingEventMsgSpoolFileCountThreshold: {
        type: "EventThresholdByPercent";
    }

    • type: "EventThresholdByPercent"

  • guaranteedMsgingEventMsgSpoolUsageThreshold: {
        type: "EventThreshold";
    }

    • type: "EventThreshold"

  • guaranteedMsgingEventTransactedSessionCountThreshold: {
        type: "EventThreshold";
    }

    • type: "EventThreshold"

  • guaranteedMsgingEventTransactedSessionResourceCountThreshold: {
        type: "EventThresholdByPercent";
    }

    • type: "EventThresholdByPercent"

  • guaranteedMsgingEventTransactionCountThreshold: {
        type: "EventThreshold";
    }

    • type: "EventThreshold"

  • guaranteedMsgingMaxCacheUsage: {
        description: "Guaranteed messaging cache usage limit. Expressed as a maximum percentage of the NAB's egress queueing. resources that the guaranteed message cache is allowed to use. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `10`. Available since 2.18.";
        format: "int32";
        type: "number";
    }

    • description: "Guaranteed messaging cache usage limit. Expressed as a maximum percentage of the NAB's egress queueing. resources that the guaranteed message cache is allowed to use. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `10`. Available since 2.18."

    • format: "int32"

    • type: "number"

  • guaranteedMsgingMaxMsgSpoolUsage: {
        description: "The maximum total message spool usage allowed across all VPNs on this broker, in megabytes. Recommendation: the maximum value should be less than 90% of the disk space allocated for the guaranteed message spool. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1500`. Available since 2.18.";
        format: "int64";
        type: "number";
    }

    • description: "The maximum total message spool usage allowed across all VPNs on this broker, in megabytes. Recommendation: the maximum value should be less than 90% of the disk space allocated for the guaranteed message spool. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1500`. Available since 2.18."

    • format: "int64"

    • type: "number"

  • guaranteedMsgingMsgSpoolSyncMirroredMsgAckTimeout: {
        description: "The maximum time, in milliseconds, that can be tolerated for remote acknowledgement of synchronization messages before which the remote system will be considered out of sync. The default value is `10000`. Available since 2.18.";
        format: "int64";
        type: "number";
    }

    • description: "The maximum time, in milliseconds, that can be tolerated for remote acknowledgement of synchronization messages before which the remote system will be considered out of sync. The default value is `10000`. Available since 2.18."

    • format: "int64"

    • type: "number"

  • guaranteedMsgingMsgSpoolSyncMirroredSpoolFileAckTimeout: {
        description: "The maximum time, in milliseconds, that can be tolerated for remote disk writes before which the remote system will be considered out of sync. The default value is `10000`. Available since 2.18.";
        format: "int64";
        type: "number";
    }

    • description: "The maximum time, in milliseconds, that can be tolerated for remote disk writes before which the remote system will be considered out of sync. The default value is `10000`. Available since 2.18."

    • format: "int64"

    • type: "number"

  • guaranteedMsgingTransactionReplicationCompatibilityMode: {
        type: "Enum";
    }

    • type: "Enum"

  • oauthProfileDefault: {
        description: "The default OAuth profile for OAuth authenticated SEMP requests. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. Available since 2.24.";
        type: "string";
    }

    • description: "The default OAuth profile for OAuth authenticated SEMP requests. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. Available since 2.24."

    • type: "string"

  • serviceAmqpEnabled: {
        description: "Enable or disable the AMQP service. When disabled new AMQP Clients may not connect through the global or per-VPN AMQP listen-ports, and all currently connected AMQP Clients are immediately disconnected. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.17.";
        type: "boolean";
    }

    • description: "Enable or disable the AMQP service. When disabled new AMQP Clients may not connect through the global or per-VPN AMQP listen-ports, and all currently connected AMQP Clients are immediately disconnected. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.17."

    • type: "boolean"

  • serviceAmqpTlsListenPort: {
        description: "TCP port number that AMQP clients can use to connect to the broker using raw TCP over TLS. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `0`. Available since 2.17.";
        format: "int64";
        type: "number";
    }

    • description: "TCP port number that AMQP clients can use to connect to the broker using raw TCP over TLS. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `0`. Available since 2.17."

    • format: "int64"

    • type: "number"

  • serviceEventConnectionCountThreshold: {
        type: "EventThreshold";
    }

    • type: "EventThreshold"

  • serviceHealthCheckEnabled: {
        description: "Enable or disable the health-check service. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.17.";
        type: "boolean";
    }

    • description: "Enable or disable the health-check service. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.17."

    • type: "boolean"

  • serviceHealthCheckListenPort: {
        description: "The port number for the health-check service. The port must be unique across the message backbone. The health-check service must be disabled to change the port. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `5550`. Available since 2.17.";
        format: "int64";
        type: "number";
    }

    • description: "The port number for the health-check service. The port must be unique across the message backbone. The health-check service must be disabled to change the port. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `5550`. Available since 2.17."

    • format: "int64"

    • type: "number"

  • serviceMateLinkEnabled: {
        description: "Enable or disable the mate-link service. The default value is `true`. Available since 2.17.";
        type: "boolean";
    }

    • description: "Enable or disable the mate-link service. The default value is `true`. Available since 2.17."

    • type: "boolean"

  • serviceMateLinkListenPort: {
        description: "The port number for the mate-link service. The port must be unique across the message backbone. The mate-link service must be disabled to change the port. The default value is `8741`. Available since 2.17.";
        format: "int64";
        type: "number";
    }

    • description: "The port number for the mate-link service. The port must be unique across the message backbone. The mate-link service must be disabled to change the port. The default value is `8741`. Available since 2.17."

    • format: "int64"

    • type: "number"

  • serviceMqttEnabled: {
        description: "Enable or disable the MQTT service. When disabled new MQTT Clients may not connect through the per-VPN MQTT listen-ports, and all currently connected MQTT Clients are immediately disconnected. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.17.";
        type: "boolean";
    }

    • description: "Enable or disable the MQTT service. When disabled new MQTT Clients may not connect through the per-VPN MQTT listen-ports, and all currently connected MQTT Clients are immediately disconnected. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.17."

    • type: "boolean"

  • serviceMsgBackboneEnabled: {
        description: "Enable or disable the msg-backbone service. When disabled new Clients may not connect through global or per-VPN listen-ports, and all currently connected Clients are immediately disconnected. The default value is `true`. Available since 2.17.";
        type: "boolean";
    }

    • description: "Enable or disable the msg-backbone service. When disabled new Clients may not connect through global or per-VPN listen-ports, and all currently connected Clients are immediately disconnected. The default value is `true`. Available since 2.17."

    • type: "boolean"

  • serviceRedundancyEnabled: {
        description: "Enable or disable the redundancy service. The default value is `true`. Available since 2.17.";
        type: "boolean";
    }

    • description: "Enable or disable the redundancy service. The default value is `true`. Available since 2.17."

    • type: "boolean"

  • serviceRedundancyFirstListenPort: {
        description: "The first listen-port used for the redundancy service. Redundancy uses this port and the subsequent 2 ports. These port must be unique across the message backbone. The redundancy service must be disabled to change this port. The default value is `8300`. Available since 2.17.";
        format: "int64";
        type: "number";
    }

    • description: "The first listen-port used for the redundancy service. Redundancy uses this port and the subsequent 2 ports. These port must be unique across the message backbone. The redundancy service must be disabled to change this port. The default value is `8300`. Available since 2.17."

    • format: "int64"

    • type: "number"

  • serviceRestEventOutgoingConnectionCountThreshold: {
        type: "EventThreshold";
    }

    • type: "EventThreshold"

  • serviceRestIncomingEnabled: {
        description: "Enable or disable the REST service incoming connections on the router. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.17.";
        type: "boolean";
    }

    • description: "Enable or disable the REST service incoming connections on the router. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.17."

    • type: "boolean"

  • serviceRestOutgoingEnabled: {
        description: "Enable or disable the REST service outgoing connections on the router. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.17.";
        type: "boolean";
    }

    • description: "Enable or disable the REST service outgoing connections on the router. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.17."

    • type: "boolean"

  • serviceSempCorsAllowAnyHostEnabled: {
        description: "Enable or disable cross origin resource requests for the SEMP service. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. Available since 2.24.";
        type: "boolean";
    }

    • description: "Enable or disable cross origin resource requests for the SEMP service. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. Available since 2.24."

    • type: "boolean"

  • serviceSempLegacyTimeoutEnabled: {
        description: "Enable or disable extended SEMP timeouts for paged GETs. When a request times out, it returns the current page of content, even if the page is not full. When enabled, the timeout is 60 seconds. When disabled, the timeout is 5 seconds. The recommended setting is disabled (no legacy-timeout). This parameter is intended as a temporary workaround to be used until SEMP clients can handle short pages. This setting will be removed in a future release. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.18.";
        type: "boolean";
    }

    • description: "Enable or disable extended SEMP timeouts for paged GETs. When a request times out, it returns the current page of content, even if the page is not full. When enabled, the timeout is 60 seconds. When disabled, the timeout is 5 seconds. The recommended setting is disabled (no legacy-timeout). This parameter is intended as a temporary workaround to be used until SEMP clients can handle short pages. This setting will be removed in a future release. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.18."

    • type: "boolean"

  • serviceSempPlainTextEnabled: {
        description: "Enable or disable plain-text SEMP service. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. Available since 2.17.";
        type: "boolean";
    }

    • description: "Enable or disable plain-text SEMP service. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. Available since 2.17."

    • type: "boolean"

  • serviceSempPlainTextListenPort: {
        description: "The TCP port for plain-text SEMP client connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `80`. Available since 2.17.";
        format: "int64";
        type: "number";
    }

    • description: "The TCP port for plain-text SEMP client connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `80`. Available since 2.17."

    • format: "int64"

    • type: "number"

  • serviceSempSessionIdleTimeout: {
        description: "The session idle timeout, in minutes. Sessions will be invalidated if there is no activity in this period of time. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `15`. Available since 2.21.";
        format: "int32";
        type: "number";
    }

    • description: "The session idle timeout, in minutes. Sessions will be invalidated if there is no activity in this period of time. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `15`. Available since 2.21."

    • format: "int32"

    • type: "number"

  • serviceSempSessionMaxLifetime: {
        description: "The maximum lifetime of a session, in minutes. Sessions will be invalidated after this period of time, regardless of activity. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `43200`. Available since 2.21.";
        format: "int32";
        type: "number";
    }

    • description: "The maximum lifetime of a session, in minutes. Sessions will be invalidated after this period of time, regardless of activity. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `43200`. Available since 2.21."

    • format: "int32"

    • type: "number"

  • serviceSempTlsEnabled: {
        description: "Enable or disable TLS SEMP service. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. Available since 2.17.";
        type: "boolean";
    }

    • description: "Enable or disable TLS SEMP service. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. Available since 2.17."

    • type: "boolean"

  • serviceSempTlsListenPort: {
        description: "The TCP port for TLS SEMP client connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1943`. Available since 2.17.";
        format: "int64";
        type: "number";
    }

    • description: "The TCP port for TLS SEMP client connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1943`. Available since 2.17."

    • format: "int64"

    • type: "number"

  • serviceSmfCompressionListenPort: {
        description: "TCP port number that SMF clients can use to connect to the broker using raw compression TCP. The default value is `55003`. Available since 2.17.";
        format: "int64";
        type: "number";
    }

    • description: "TCP port number that SMF clients can use to connect to the broker using raw compression TCP. The default value is `55003`. Available since 2.17."

    • format: "int64"

    • type: "number"

  • serviceSmfEnabled: {
        description: "Enable or disable the SMF service. When disabled new SMF Clients may not connect through the global listen-ports, and all currently connected SMF Clients are immediately disconnected. The default value is `true`. Available since 2.17.";
        type: "boolean";
    }

    • description: "Enable or disable the SMF service. When disabled new SMF Clients may not connect through the global listen-ports, and all currently connected SMF Clients are immediately disconnected. The default value is `true`. Available since 2.17."

    • type: "boolean"

  • serviceSmfEventConnectionCountThreshold: {
        type: "EventThreshold";
    }

    • type: "EventThreshold"

  • serviceSmfPlainTextListenPort: {
        description: "TCP port number that SMF clients can use to connect to the broker using raw TCP. The default value is `55555`. Available since 2.17.";
        format: "int64";
        type: "number";
    }

    • description: "TCP port number that SMF clients can use to connect to the broker using raw TCP. The default value is `55555`. Available since 2.17."

    • format: "int64"

    • type: "number"

  • serviceSmfRoutingControlListenPort: {
        description: "TCP port number that SMF clients can use to connect to the broker using raw routing control TCP. The default value is `55556`. Available since 2.17.";
        format: "int64";
        type: "number";
    }

    • description: "TCP port number that SMF clients can use to connect to the broker using raw routing control TCP. The default value is `55556`. Available since 2.17."

    • format: "int64"

    • type: "number"

  • serviceSmfTlsListenPort: {
        description: "TCP port number that SMF clients can use to connect to the broker using raw TCP over TLS. The default value is `55443`. Available since 2.17.";
        format: "int64";
        type: "number";
    }

    • description: "TCP port number that SMF clients can use to connect to the broker using raw TCP over TLS. The default value is `55443`. Available since 2.17."

    • format: "int64"

    • type: "number"

  • serviceTlsEventConnectionCountThreshold: {
        type: "EventThreshold";
    }

    • type: "EventThreshold"

  • serviceWebTransportEnabled: {
        description: "Enable or disable the web-transport service. When disabled new web-transport Clients may not connect through the global listen-ports, and all currently connected web-transport Clients are immediately disconnected. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.17.";
        type: "boolean";
    }

    • description: "Enable or disable the web-transport service. When disabled new web-transport Clients may not connect through the global listen-ports, and all currently connected web-transport Clients are immediately disconnected. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.17."

    • type: "boolean"

  • serviceWebTransportPlainTextListenPort: {
        description: "The TCP port for plain-text WEB client connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `8008`. Available since 2.17.";
        format: "int64";
        type: "number";
    }

    • description: "The TCP port for plain-text WEB client connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `8008`. Available since 2.17."

    • format: "int64"

    • type: "number"

  • serviceWebTransportTlsListenPort: {
        description: "The TCP port for TLS WEB client connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1443`. Available since 2.17.";
        format: "int64";
        type: "number";
    }

    • description: "The TCP port for TLS WEB client connections. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `1443`. Available since 2.17."

    • format: "int64"

    • type: "number"

  • serviceWebTransportWebUrlSuffix: {
        description: "Used to specify the Web URL suffix that will be used by Web clients when communicating with the broker. The default value is `\"\"`. Available since 2.17.";
        type: "string";
    }

    • description: "Used to specify the Web URL suffix that will be used by Web clients when communicating with the broker. The default value is `\"\"`. Available since 2.17."

    • type: "string"

  • tlsBlockVersion11Enabled: {
        description: "Enable or disable the blocking of TLS version 1.1 connections. When blocked, all existing incoming and outgoing TLS 1.1 connections with Clients, SEMP users, and LDAP servers remain connected while new connections are blocked. Note that support for TLS 1.1 will eventually be discontinued, at which time TLS 1.1 connections will be blocked regardless of this setting. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`.";
        type: "boolean";
    }

    • description: "Enable or disable the blocking of TLS version 1.1 connections. When blocked, all existing incoming and outgoing TLS 1.1 connections with Clients, SEMP users, and LDAP servers remain connected while new connections are blocked. Note that support for TLS 1.1 will eventually be discontinued, at which time TLS 1.1 connections will be blocked regardless of this setting. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`."

    • type: "boolean"

  • tlsCipherSuiteManagementList: {
        description: "The colon-separated list of cipher suites used for TLS management connections (e.g. SEMP, LDAP). The value \"default\" implies all supported suites ordered from most secure to least secure. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"default\"`.";
        type: "string";
    }

    • description: "The colon-separated list of cipher suites used for TLS management connections (e.g. SEMP, LDAP). The value \"default\" implies all supported suites ordered from most secure to least secure. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"default\"`."

    • type: "string"

  • tlsCipherSuiteMsgBackboneList: {
        description: "The colon-separated list of cipher suites used for TLS data connections (e.g. client pub/sub). The value \"default\" implies all supported suites ordered from most secure to least secure. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"default\"`.";
        type: "string";
    }

    • description: "The colon-separated list of cipher suites used for TLS data connections (e.g. client pub/sub). The value \"default\" implies all supported suites ordered from most secure to least secure. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"default\"`."

    • type: "string"

  • tlsCipherSuiteSecureShellList: {
        description: "The colon-separated list of cipher suites used for TLS secure shell connections (e.g. SSH, SFTP, SCP). The value \"default\" implies all supported suites ordered from most secure to least secure. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"default\"`.";
        type: "string";
    }

    • description: "The colon-separated list of cipher suites used for TLS secure shell connections (e.g. SSH, SFTP, SCP). The value \"default\" implies all supported suites ordered from most secure to least secure. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"default\"`."

    • type: "string"

  • tlsCrimeExploitProtectionEnabled: {
        description: "Enable or disable protection against the CRIME exploit. When enabled, TLS+compressed messaging performance is degraded. This protection should only be disabled if sufficient ACL and authentication features are being employed such that a potential attacker does not have sufficient access to trigger the exploit. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`.";
        type: "boolean";
    }

    • description: "Enable or disable protection against the CRIME exploit. When enabled, TLS+compressed messaging performance is degraded. This protection should only be disabled if sufficient ACL and authentication features are being employed such that a potential attacker does not have sufficient access to trigger the exploit. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`."

    • type: "boolean"

  • tlsServerCertContent: {
        description: "The PEM formatted content for the server certificate used for TLS connections. 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 `\"\"`.";
        type: "string";
    }

    • description: "The PEM formatted content for the server certificate used for TLS connections. 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 `\"\"`."

    • type: "string"

  • tlsServerCertPassword: {
        description: "The password for the server certificate used for TLS connections. 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 `\"\"`.";
        type: "string";
    }

    • description: "The password for the server certificate used for TLS connections. 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 `\"\"`."

    • type: "string"

  • tlsStandardDomainCertificateAuthoritiesEnabled: {
        description: "Enable or disable the standard domain certificate authority list. The default value is `true`. Available since 2.19.";
        type: "boolean";
    }

    • description: "Enable or disable the standard domain certificate authority list. The default value is `true`. Available since 2.19."

    • type: "boolean"

  • tlsTicketLifetime: {
        description: "The TLS ticket lifetime in seconds. When a client connects with TLS, a session with a session ticket is created using the TLS ticket lifetime which determines how long the client has to resume the session. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `86400`.";
        format: "int32";
        type: "number";
    }

    • description: "The TLS ticket lifetime in seconds. When a client connects with TLS, a session with a session ticket is created using the TLS ticket lifetime which determines how long the client has to resume the session. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `86400`."

    • format: "int32"

    • type: "number"

  • webManagerAllowUnencryptedWizardsEnabled: {
        description: "Enable or disable the use of unencrypted wizards in the Web-based Manager UI. This setting should be left at its default on all production systems or other systems that need to be secure. Enabling this option will permit the broker to forward plain-text data to other brokers, making important information or credentials available for snooping. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.28.";
        type: "boolean";
    }

    • description: "Enable or disable the use of unencrypted wizards in the Web-based Manager UI. This setting should be left at its default on all production systems or other systems that need to be secure. Enabling this option will permit the broker to forward plain-text data to other brokers, making important information or credentials available for snooping. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `false`. Available since 2.28."

    • type: "boolean"

  • webManagerCustomization: {
        description: "Reserved for internal use by Solace. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. Available since 2.25.";
        type: "string";
    }

    • description: "Reserved for internal use by Solace. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `\"\"`. Available since 2.25."

    • type: "string"

  • webManagerRedirectHttpEnabled: {
        description: "Enable or disable redirection of HTTP requests for the broker manager to HTTPS. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. Available since 2.24.";
        type: "boolean";
    }

    • description: "Enable or disable redirection of HTTP requests for the broker manager to HTTPS. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `true`. Available since 2.24."

    • type: "boolean"

  • webManagerRedirectHttpOverrideTlsPort: {
        description: "The HTTPS port that HTTP requests will be redirected towards in a HTTP 301 redirect response. Zero is a special value that means use the value specified for the SEMP TLS port value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `0`. Available since 2.24.";
        format: "int32";
        type: "number";
    }

    • description: "The HTTPS port that HTTP requests will be redirected towards in a HTTP 301 redirect response. Zero is a special value that means use the value specified for the SEMP TLS port value. Changes to this attribute are synchronized to HA mates via config-sync. The default value is `0`. Available since 2.24."

    • format: "int32"

    • type: "number"