nvflare.fuel.utils.admin_name_utils module

is_valid_admin_client_name(name: str) → bool

Check whether the specified name is a valid admin client name.

Parameters:

name – the name to be checked.

Returns: whether the name is valid admin client name

new_admin_client_name()

Create a unique name for a new admin client session. Note that we cannot use the admin user’s login name because the same user could have multiple admin sessions at the same time. The admin client name is also the FQCN of the client when connecting to the server.

The admin client name is created with this pattern:

<prefix><uid>

where the prefix is fixed, whereas uid is a unique ID.

Returns: a unique name