8.5.1. NGCLIENT-SITES¶

8.5.1.1. SYNOPSIS¶

ngclient sites refresh [options...]

8.5.1.2. DESCRIPTION¶

The sites refresh command is used to trigger a refresh of site-specific metadata in Ngenea Hub.

Site metadata includes things like storage pools, filesystems, analytics, etc. This metadata is typically refreshed periodically, but if the data currently returned from Ngenea Hub seems wrong or out of date, this command can be used to force a refresh.

Base URL and API key settings can be read from a config file, rather than being passed on the command line. See ngenea-client.conf(5) for more information on the configuration format. CLI flags take precedence over config file settings.

Interacting with features requires Ngenea Hub authentication. The ngclient(1) authenticate command can be used to generate a client key from a username or access token.

8.5.1.3. OPTION SUMMARY¶

    --site                 Name of a specific site to refresh settings from

    --base-url             Base URL of the {{ brand_name }} API

-c, --config CONFIG        Alternative configuration file path
    --client-key KEY       Client API key to authenticate with

-h, --help                 Print help message and exit

8.5.1.3.1. OPTIONS¶

--site

Name of a specific site to refresh metadata on.

If this flag isn't specified, metadata will be refreshed for all sites registered in Ngenea Hub
--base-url

Base URL of the Ngenea Hub API, which operations will be performed against.

This can be used to perform Ngenea Hub operations on a remote server.

If not specified, the default is http://localhost:8000/api
-c, --config

The path to an alternative configuration file.

If not specified, the default configuration paths will be used. The default paths are in the user's HOME directory $HOME/.config/ngenea/ngenea-client.conf, and the global configuration at /etc/ngenea/ngenea-client.conf

See ngenea-client.conf(5) for more information on the configuration format.

Command line options take precedence over any corresponding config file settings.
--client-key

Ngenea Hub authentication client key.

This can be generated via the Ngenea Hub REST API, or using ngclient(1) authenticate
-h, --help

Prints the help message.

8.5.1.4. EXAMPLES¶

The following examples assume that the client key has been saved in the default config file.

8.5.1.4.1. REFRESH METADATA ON ONE SITE¶

$ ngclient sites refresh --site london

8.5.1.4.2. REFRESH METADATA ON ALL SITES¶

ngclient sites refresh

8.5.1.5. AVAILABILITY¶

Distributed as part of the ngenea-hub-client rpm, or the ngclient wheel (Python) for non-Red Hat based systems.

The ngclient wheel can be installed and run on any operating system.

8.5.1.6. SEE ALSO¶

ngclient(1), ngenea-client.conf(5)

8.5.1.7. LICENSE¶

2023 ArcaPix Limited

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.