PingAuthorize Server Documentation Index
Configuration Reference Home

Redis Sentinel External Attribute Cache

Note: this component stores cluster-wide configuration data and is mirrored across all servers in the topology within the the same cluster.

Note: changes to cluster-wide configuration objects are immediately and automatically mirrored across all servers within the same cluster, so offline changes are not supported.

Redis Sentinel External Attribute Caches represent locations where the PingAuthorize Server can connect to external Redis caches deployed in a sentinel configuration.

↓Parent Component
↓Properties
↓dsconfig Usage

Parent Component

The Redis Sentinel External Attribute Cache component inherits from the External Attribute Cache

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ redis-sentinel-addresses  None
↓ redis-master-name
↓ redis-database-index
↓ redis-scan-interval
↓ check-sentinel-list
↓ username
↓ password

Basic Properties

redis-sentinel-addresses

Description
The node addresses of the Redis Cache sentinel(s), e.g "redis://host:6379", seperated by commas.
Default Value

Allowed Values
A string
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

redis-master-name

Description
The name of the master instance in a Redis sentinel configuration.
Default Value

Allowed Values
A string
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

redis-database-index

Description
The database index to use when connecting to the Redis Sentinel instances.
Default Value

Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

redis-scan-interval

Description
Redis scan interval in milliseconds.
Default Value
1000 ms
Allowed Values
A duration. Lower limit is 0 milliseconds.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

check-sentinel-list

Description
Enables sentinels list check during startup.
Default Value
false
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

username

Description
Specifies the username to be used when connecting to the Redis Sentinel External Attribute Cache.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

password

Description
Specifies the password to be used when connecting to the Redis Sentinel External Attribute Cache.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured External Attribute Caches:

dsconfig list-external-attribute-caches
     [--property {propertyName}] ...

To view the configuration for an existing External Attribute Cache:

dsconfig get-external-attribute-cache-prop
     --cache-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing External Attribute Cache:

dsconfig set-external-attribute-cache-prop
     --cache-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new Redis Sentinel External Attribute Cache:

dsconfig create-external-attribute-cache
     --cache-name {name}
     --type redis-sentinel
     [--set {propertyName}:{propertyValue}] ...

To delete an existing External Attribute Cache:

dsconfig delete-external-attribute-cache
     --cache-name {name}