ltm profile georedundancy
ltm profile georedundancy(1) BIG-IP TMSH Manual ltm profile georedundancy(1)
NAME
georedundancy - Configures a Geo-Redundancy profile.
MODULE
ltm profile
SYNTAX
Configure the georedundancy component within the ltm profile module
using the syntax shown in the following sections.
CREATE/MODIFY
create georedundancy [name]
modify georedundancy [name]
options:
defaults-from [ [name] | none]
description [string]
local-site-id [string]
remote-site-id [string]
read-broker-list [string]
write-broker-list [string]
sessiondb-bins [string]
topic-name-format [string]
enabled [true | false]
require-coherency [true | false]
message-max-bytes [integer]
receive-message-max-bytes [integer]
message-copy-max-bytes [integer]
max-in-flight-reqests-per-connection [integer]
metadata-request-timeout-ms [integer]
metadata-refresh-interval-ms [integer]
metadata-max-age-ms [integer]
metadata-refresh-fast-interval-ms [integer]
debug [string]
group-id [string]
client-id [string]
session-timeout-ms [integer]
heartbeat-interval-ms [integer]
coordinator-query-interval-ms [integer]
queued-min-messages [integer]
queued-max-messages-kbytes [integer]
fetch-wait-max-ms [integer]
fetch-message-max-bytes [integer]
fetch-min-bytes [integer]
fetch-error-backoff-ms [integer]
enable-partition-eof [true | false]
check-crcs [true | false]
queue-buffering-max-messages [integer]
queue-buffering-max-kbytes [integer]
queue-buffering-max-ms [integer]
message-send-max-retries [integer]
retry-backoff-ms [integer]
batch-num-messages [integer]
compression-codec [none | gzip | snappy | lz4]
request-timeout-ms [integer]
message-timeout-ms [integer]
auto-commit-interval-ms [integer]
consume-callback-max-messages [integer]
auto-offset-reset [smallest | earliest | beginning | largest | latest | end | error]
edit georedundancy [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
mv georedundancy [ [[source-name] [destination-name]] | [[name] to-folder [folder-name]] | [[name...name] to-folder [folder-name]] ]
options:
to-folder
reset-stats georedundancy
reset-stats georedundancy [ [ [name] | [glob] | [regex] ] ... ]
DISPLAY
list georedundancy
list georedundancy [ [ [name] | [glob] | [regex] ] ... ]
show running-config georedundancy
show running-config georedundancy [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line
partition
show georedundancy
show georedundancy [ [ [name] | [glob] | [regex] ] ... ]
options:
(default | exa | gig | kil | meg | peta | raw | tera | yotta | zetta)
field-fmt
DELETE
delete georedundancy [name]
DESCRIPTION
You can use the georedundancy component to manage a Geo-Redundancy
profile.
EXAMPLES
create georedundancy my_georedundancy_profile defaults-from
georedundancy
Creates a Geo-Redundancy profile named my_georedundancy_profile using
the system defaults.
create georedundancy my_georedundancy_profile { local-site-id
local_site }
Creates a Geo-Redundancy profile named my_georedundancy_profile with a
name of the local site identification set to local_site.
mv georedundancy /Common/my_georedundancy_profile to-folder
/Common/my_folder
Moves a custom georedundancy profile named my_georedundancy_profile to
a folder named my_folder, where my_folder has already been created and
exists within /Common.
OPTIONS
local-site-id
Defines the name to identify local site . The default value is
local_site.
remote-site-ids
Defines the list of comma separated names corresponding to remote
sites. The default value is remote_site.
read-broker-list
Specifies the list of local site broker's IP addresses and ports
for the local TMMs to read the data from. Example:
127.20.1.254:9092, 127.20.2.254:9092.
write-broker-list
Specifies the list of local site broker's IP addresses and ports
for the local TMMs to write the data to. Example:
127.20.1.254:9092, 127.20.2.254:9092.
sessiondb-bins
Specifies the list of sessionDB bins. The session records in the
bins will be replicated geographically.
enabled
Defines if Geo-Redundancy profile is enabled or not. If it is
enabled, then the parameters in this profile will be used to do
the geo-redundancy. Otherwise, this is just a configuration, not
active yet. The default value is enabled.
topic-name-format
Defines the format to define a topic. For example on local broker,
the local writer queue's topic name is: [bin-id]_[local-site-id];
The local reader queue's topic names are:
[bin-id]_[remote-site-id1], [bin-id]_[remote-site-id2] etc. The
topic name prefix "Restart" has special meaning. It means the
local site is restarted and need to synchronize the session data
from remote site. The format for the restart topic:
Restart_[bin-id]_[site-id].
require-coherency
This parameter dictates that virtual servers which require Geo-
Redundancy should not go active until replication has completed on
startup. Packets should be dropped until "Bin is ready" flag set.
The default vaulue is true.
message-max-bytes
Indicates the maximum size of the message to be transmitted. The
default value is 1M.
receive-message-max-bytes
Indicates the maximum size for message to be copied to buffer.
Messages larger than this will be passed by reference (zero-copy)
at the expense of larger iovecs. The default value is 65535.
message-copy-max-bytes
Indicates the maximum receive message size. This is a safety
precaution to avoid memory exhaustion in case of protocol hickups.
The value should be at least fetch.message.max.bytes * number of
partitions consumed from + messaging overhead (e.g. 200000 bytes).
The default value is 100M.
max-in-flight-reqests-per-connection
Indicates the maximum number of in-flight requests the client will
send. This setting applies per broker connection. The default
value is 1M.
metadata-request-timeout-ms
Indicates the Non-topic request timeout in milliseconds. This is
for metadata requests, etc. The default value is 60K.
metadata-refresh-interval-ms
Indicates the Topic metadata refresh interval in milliseconds. The
metadata is automatically refreshed on error and connect. Use -1
to disable the intervalled refresh. The default value is 300K.
metadata-max-age-ms
Indicates the metadata cache max age in milliseconds. The default
value is 900K.
metadata-refresh-fast-interval-ms
When a topic loses its leader a new metadata request will be
enqueued with this initial interval, exponentially increasing
until the topic metadata has been refreshed. This is used to
recover quickly from transitioning leader brokers. The default
value is 250.
debug
Defines a comma-separated list of debug contexts to enable.
Debugging the Producer: broker,topic,msg. Consumer:
cgrp,topic,fetch.
group-id
Defines the client group identifier string. All clients sharing
the same group-id belong to the same group.
client-id
Defines the client identifier string.
session-timeout-ms
Indicates the client group session and failure detection timeout
in milliseconds. The default value is 30K.
heartbeat-interval-ms
Indicates the client group session keepalive heartbeat interval in
milliseconds. The default value is 1K.
coordinator-query-interval-ms
Defines the frequency of query for the current client group
coordinator. If the currently assigned coordinator is down the
configured query interval will be divided by ten to more quickly
recover in case of coordinator reassignment. The default value is
600K.
queued-min-messages
Indicates the minimum number of messages per topic+partition in
the local consumer queue. The default value is 100K.
queued-max-messages-kbytes
Indicates the maximum number of kilobytes per topic+partition in
the local consumer queue. This value may be overshot by fetch-
message-max-bytes. The default value is 1M.
fetch-wait-max-ms
Indicates the maximum time in milliseconds the broker may wait to
fill the response with fetch-min-bytes. The default value is 100.
fetch-message-max-bytes
Indicates the maximum number of bytes per topic+partition to
request when fetching messages from the broker. If the client
encounters a message larger than this value it will gradually try
to increase it until the entire message can be fetched. The
default value is 1048576.
fetch-min-bytes
Indicates the minimum number of bytes the broker responds with. If
fetch.wait.max.ms expires the accumulated data will be sent to the
client regardless of this setting. The default value is 1.
fetch-error-backoff-ms
Indicates the duration in milliseconds to postpone the next fetch
request for a topic+partition in case of a fetch error. The
default value is 500.
enable-partition-eof
Enables or disables the partition end of file notification. When
set to true emits RD_KAFKA_RESP_ERR_PARTITION_EOF event as the
consumer reaches the end of a partition. The default value is
true.
check-crcs
Enables or disable the CRC32 verification of the consumed
messages. Ensures no on-the-wire or on-disk corruption to the
messages occurred. This check comes at slightly increased CPU
usage. The default value is false.
queue-buffering-max-messages
Indicates the maximum number of messages allowed on the producer
queue. The default value is 100K.
queue-buffering-max-kbytes
Indicates the maximum total message size sum in kilobytes allowed
on the producer queue. The default value is 4M.
queue-buffering-max-ms
Indicates the maximum time in milliseconds, for buffering data on
the producer queue. The default value is 0.
message-send-max-retries
Indicates the number of send retries on a failed MessageSet.
**Note:** retrying may cause reordering. The default value is 2.
retry-backoff-ms
Indicates the backoff time in milliseconds before retrying to send
a message. The default value is 100.
compression-codec
Indicates the compression codec to use for compressing message
sets. This is the default attribute for all topics, may be
overriden by the topic configuration property `compression-codec`.
The default value is none.
batch-num-messages
Indicates the maximum number of messages batched in one
MessageSet. The total MessageSet size is also limited by message-
max-bytes. The default value is 10K.
request-timeout-ms
Indicates the acknowledgement timeout of the producer request in
milliseconds. This value is only enforced by the broker and relies
on `request-required-acks` being != 0. The default value is 5K.
message-timeout-ms
Indicates the local message timeout in milliseconds. This value is
only enforced locally and limits the time a produced message waits
for successful delivery. A time of 0 is infinite. The default
value is 300K.
auto-commit-interval-ms
Indicates the frequency in milliseconds that the consumer offsets
are committed (written) to offset storage. This setting is used by
the low-level legacy consumer. The default value is 60K.
auto-offset-reset
Defines the action to take when there is no initial offset in
offset store or the desired offset is out of range:
'smallest','earliest' - automatically reset the offset to the
smallest offset, 'largest','latest' - automatically reset the
offset to the largest offset, 'error' - trigger an error which is
retrieved by consuming messages and checking 'message->err'. The
default value is largest.
consume-callback-max-messages
Indicates the maximum number of messages to dispatch in one
`rd_kafka_consume_callback*()` call (0 = unlimited). The default
value is 0.
SEE ALSO
create, delete, edit, glob, list, ltm virtual, modify, mv, regex,
reset-stats, show, tmsh
COPYRIGHT
No part of this program may be reproduced or transmitted in any form or
by any means, electronic or mechanical, including photocopying,
recording, or information storage and retrieval systems, for any
purpose other than the purchaser's personal use, without the express
written permission of F5 Networks, Inc.
F5 Networks and BIG-IP (c) Copyright 2008-2010, 2012-2014, 2016-2017.
All rights reserved.
BIG-IP 2019-04-25 ltm profile georedundancy(1)