Class default

ChangeModelCredential changes cloud credential reference for models. These new cloud credentials must already exist on the controller.

CreateModel creates a new model using the account and model config specified in the args.

DestroyModels will try to destroy the specified models. If there is a block on destruction, this method will return an error. From ModelManager v7 onwards, DestroyModels gains 'force' and 'max-wait' parameters.

DumpModels will export the models into the database agnostic representation. The user needs to either be a controller admin, or have admin privileges on the model itself.

DumpModelsDB will gather all documents from all model collections for the specified model. The map result contains a map of collection names to lists of documents represented as maps.

ListModelSummaries returns models that the specified user has access to in the current server. Controller admins (superuser) can list models for any user. Other users can only ask about their own models.

ListModels returns the models that the specified user has access to in the current server. Controller admins (superuser) can list models for any user. Other users can only ask about their own models.

ModelDefaults returns the default config values used when creating a new model.

ModelInfo returns information about the specified models.

ModelStatus returns a summary of the model.

ModifyModelAccess changes the model access granted to users.

SetModelDefaults writes new values for the specified default model settings.

UnsetModelDefaults removes the specified default model settings.

ValidateModelUpgrades validates if a model is allowed to perform an upgrade. Examples of why you would want to block a model upgrade, would be situations like upgrade-series. If performing an upgrade-series we don't know the current status of the machine, so performing an upgrade-model can lead to bad unintended errors down the line.