juju/model.py

   1 class Model(object):
   2     def add_machine(self):
   3         """Start a new, empty machine and optionally a container, or add a
   4         container to a machine.
   5
   6         """
   7         pass
   8     add_machines = add_machine
   9
  10     def add_relation(self):
  11         """Add a relation between two services.
  12
  13         """
  14         pass
  15
  16     def add_space(self):
  17         """Add a new network space.
  18
  19         """
  20         pass
  21
  22     def add_ssh_key(self):
  23         """Add a public SSH key to this model.
  24
  25         """
  26         pass
  27     add_ssh_keys = add_ssh_key
  28
  29     def add_subnet(self):
  30         """Add an existing subnet to this model.
  31
  32         """
  33         pass
  34
  35     def get_backups(self):
  36         """Retrieve metadata for backups in this model.
  37
  38         """
  39         pass
  40
  41     def block(self):
  42         """Add a new block to this model.
  43
  44         """
  45         pass
  46
  47     def get_blocks(self):
  48         """List blocks for this model.
  49
  50         """
  51         pass
  52
  53     def get_cached_images(self):
  54         """Return a list of cached OS images.
  55
  56         """
  57         pass
  58
  59     def create_backup(self):
  60         """Create a backup of this model.
  61
  62         """
  63         pass
  64
  65     def create_storage_pool(self):
  66         """Create or define a storage pool.
  67
  68         """
  69         pass
  70
  71     def debug_log(self):
  72         """Get log messages for this model.
  73
  74         """
  75         pass
  76
  77     def deploy(self):
  78         """Deploy a new service or bundle.
  79
  80         """
  81         pass
  82
  83     def destroy(self):
  84         """Terminate all machines and resources for this model.
  85
  86         """
  87         pass
  88
  89     def get_backup(self):
  90         """Download a backup archive file.
  91
  92         """
  93         pass
  94
  95     def enable_ha(self):
  96         """Ensure sufficient controllers exist to provide redundancy.
  97
  98         """
  99         pass
 100
 101     def get_config(self):
 102         """Return the configuration settings for this model.
 103
 104         """
 105         pass
 106
 107     def get_constraints(self):
 108         """Return the machine constraints for this model.
 109
 110         """
 111         pass
 112
 113     def grant(self):
 114         """Grant a user access to this model.
 115
 116         """
 117         pass
 118
 119     def import_ssh_key(self):
 120         """Add a public SSH key from a trusted indentity source to this model.
 121
 122         """
 123         pass
 124     import_ssh_keys = import_ssh_key
 125
 126     def get_machine(self, machine_id):
 127         """Get a machine by id.
 128
 129         """
 130         pass
 131
 132     def get_machines(self):
 133         """Return list of machines in this model.
 134
 135         """
 136         pass
 137
 138     def get_shares(self):
 139         """Return list of all users with access to this model.
 140
 141         """
 142         pass
 143
 144     def get_spaces(self):
 145         """Return list of all known spaces, including associated subnets.
 146
 147         """
 148         pass
 149
 150     def get_ssh_key(self):
 151         """Return known SSH keys for this model.
 152
 153         """
 154         pass
 155     get_ssh_keys = get_ssh_key
 156
 157     def get_storage(self):
 158         """Return details of storage instances.
 159
 160         """
 161         pass
 162
 163     def get_storage_pools(self):
 164         """Return list of storage pools.
 165
 166         """
 167         pass
 168
 169     def get_subnets(self):
 170         """Return list of known subnets.
 171
 172         """
 173         pass
 174
 175     def remove_blocks(self):
 176         """Remove all blocks from this model.
 177
 178         """
 179         pass
 180
 181     def remove_backup(self):
 182         """Delete a backup.
 183
 184         """
 185         pass
 186
 187     def remove_cached_images(self):
 188         """Remove cached OS images.
 189
 190         """
 191         pass
 192
 193     def remove_machine(self):
 194         """Remove a machine from this model.
 195
 196         """
 197         pass
 198     remove_machines = remove_machine
 199
 200     def remove_ssh_key(self):
 201         """Remove a public SSH key(s) from this model.
 202
 203         """
 204         pass
 205     remove_ssh_keys = remove_ssh_key
 206
 207     def resolved(self):
 208         """Mark unit errors resolved.
 209
 210         """
 211         pass
 212
 213     def restore_backup(self):
 214         """Restore a backup archive to a new controller.
 215
 216         """
 217         pass
 218
 219     def retry_provisioning(self):
 220         """Retry provisioning for failed machines.
 221
 222         """
 223         pass
 224
 225     def revoke(self):
 226         """Revoke a user's access to this model.
 227
 228         """
 229         pass
 230
 231     def run(self):
 232         """Run command on all machines in this model.
 233
 234         """
 235         pass
 236
 237     def set_config(self):
 238         """Set configuration keys on this model.
 239
 240         """
 241         pass
 242
 243     def set_constraints(self):
 244         """Set machine constraints on this model.
 245
 246         """
 247         pass
 248
 249     def get_action_output(self, action_uuid):
 250         """Get the results of an action by ID.
 251
 252         """
 253         pass
 254
 255     def get_action_status(self, uuid_or_prefix):
 256         """Get the status of all actions, filtered by ID or prefix.
 257
 258         """
 259         pass
 260
 261     def get_budget(self, budget_name):
 262         """Get budget by name.
 263
 264         """
 265         pass
 266
 267     def get_status(self):
 268         """Return the status of the model.
 269
 270         """
 271         pass
 272     status = get_status
 273
 274     def sync_tools(self):
 275         """Copy Juju tools into this model.
 276
 277         """
 278         pass
 279
 280     def unblock(self, operation):
 281         """Unblock an operation that would alter this model.
 282
 283         """
 284         pass
 285
 286     def unset_config(self):
 287         """Unset configuration on this model.
 288
 289         """
 290         pass
 291
 292     def upgrade_gui(self):
 293         """Upgrade the Juju GUI for this model.
 294
 295         """
 296         pass
 297
 298     def upload_backup(self):
 299         """Store a backup archive remotely in Juju.
 300
 301         """
 302         pass