Command Line Interface¶

Execute Cloud recipes

usage: scullery [-h] [-A] [-C CLOUD] [-V] [-d]
                {ecs,vms,deh,groups,group,grp,g,images,ims,im,kermit,ker,kk,project,projects,prj,p,resources,rms,rsc,roles,role,show-proxy-cfg,spc,showproxy,showcfg,tags,tms,users,user,usr,u}
                ...

Named Arguments¶

-A, --autocfg

Use WinReg to configure proxy

Default: False

-C, --cloud

Specify default cloud config

-V, --version

show program’s version number and exit

-d, --debug

Turn on debugging options

Default: False

Sub-commands¶

ecs (vms, deh)¶

ECS management

scullery ecs [-h]
             {servers,start,on,stop,off,reboot,az,availability-zones,flavors,flavours,f,types,deh-types,deh}
             ...

Sub-commands¶

servers¶

List ECS servers

scullery ecs servers [-h] [query ...]

Positional Arguments¶

query: Query arguments

start (on)¶

Start server

scullery ecs start [-h] server [server ...]

Positional Arguments¶

server: server(s) to start

stop (off)¶

Stop server

scullery ecs stop [-h] [-s | -f] server [server ...]

Positional Arguments¶

server: server(s) to start

Named Arguments¶

-s, --soft

Graceful shutdown

Default: False

-f, --hard

Hard power off

Default: False

reboot¶

Reboot server

scullery ecs reboot [-h] [-s | -f] server [server ...]

Positional Arguments¶

server: server(s) to stop

Named Arguments¶

-s, --soft

Soft reboot

Default: False

-f, --hard

Hard reset

Default: False

az (availability-zones)¶

List availability zones

scullery ecs az [-h]

flavors (flavours, f)¶

List flavors

scullery ecs flavors [-h] [query ...]

Positional Arguments¶

query: Query arguments

types (deh-types, deh)¶

List dedicated host types

scullery ecs types [-h]

groups (group, grp, g)¶

Group recipes

scullery groups [-h] {get,g,add,create,new,a,del,rm,d,rr} ...

Sub-commands¶

get (g)¶

Get details for group

scullery groups get [-h] group [group ...]

Positional Arguments¶

group: Group to look-up

add (create, new, a)¶

Add group

scullery groups add [-h] [-d DESCRIPTION] [-p PROJECT] name

Positional Arguments¶

name: Group name

Named Arguments¶

-d, --description, --desc: Optional description
-p, --project, --proj: Include project name in description

del (rm, d, rr)¶

Delete group

scullery groups del [-h] name [name ...]

Positional Arguments¶

name: Group name to delete

images (ims, im)¶

Image management

scullery images [-h] {get,g,list,find,ls,f} ...

Sub-commands¶

get (g)¶

Get details for image

scullery images get [-h] image [image ...]

Positional Arguments¶

image: Image to check

list (find, ls, f)¶

Find image

scullery images list [-h] [param ...]

Positional Arguments¶

param: Key=value parameters to filter list

kermit (ker, kk)¶

Kermit recipe

scullery kermit [-h] [-d DESC] [-s SPEC] [-o OUTPUT] project

Positional Arguments¶

project: Project name

Named Arguments¶

-d, --description, --desc

Project description

-s, --spec

Spec file

-o, --output

Output file

Default: <_io.TextIOWrapper name='<stdout>' mode='w' encoding='utf-8'>

project (projects, prj, p)¶

Project Management service

scullery project [-h]
                 {get,g,add,create,new,a,del,remove,rm,r,grant,gr,revoke,rev}
                 ...

Sub-commands¶

get (g)¶

Get details for project

scullery project get [-h] project [project ...]

Positional Arguments¶

project: Project to look-up

add (create, new, a)¶

Add Project

scullery project add [-h] [-d DESCRIPTION] name

Positional Arguments¶

name: Project name

Named Arguments¶

-d, --description, --desc: Optional description

del (remove, rm, r)¶

Delete Project

scullery project del [-h] [-f] name [name ...]

Positional Arguments¶

name: Project name to delete

Named Arguments¶

-f, --force

Force remove even if resources exists

Default: False

grant (gr)¶

Grant roles

scullery project grant [-h] grants [grants ...]

Positional Arguments¶

grants: Enter “role” [on] “project” [to] “group”

revoke (rev)¶

Revoke roles

scullery project revoke [-h] revokes [revokes ...]

Positional Arguments¶

revokes: Enter “role” [on] “project” [from] “group”

resources (rms, rsc)¶

Resource management

scullery resources [-h] [-m PROJECT] [-t TYPE]

Named Arguments¶

-m, --project: Match project
-t, --type: Resource type

roles (role)¶

Role recipes

scullery roles [-h]
               {system,sys,s,custom,cus,get,g,add,new,create,a,n,c,del,rm,d,rr}
               ...

Sub-commands¶

system (sys, s)¶

List system roles

scullery roles system [-h]

custom (cus)¶

List custom roles

scullery roles custom [-h]

get (g)¶

Get details for role

scullery roles get [-h] role [role ...]

Positional Arguments¶

role: Role to look-up

add (new, create, a, n, c)¶

Add role

scullery roles add [-h] [-d DESCRIPTION] [-p PROJECT] name [policy]

Positional Arguments¶

name

Role name to create

policy

Policy file (if not specified will read from stdin)

Default: <_io.TextIOWrapper name='<stdin>' mode='r' encoding='utf-8'>

Named Arguments¶

-d, --description, --desc: Description for this role
-p, --project, --proj: Include project name in description

del (rm, d, rr)¶

Delete role

scullery roles del [-h] name [name ...]

Positional Arguments¶

name: Role name to delete

show-proxy-cfg (spc, showproxy, showcfg)¶

Show proxy auto configuration

scullery show-proxy-cfg [-h]

tags (tms)¶

Tag management service

scullery tags [-h] [-a | -d] [kvp ...]

Positional Arguments¶

kvp: Key value pair (key=value

Named Arguments¶

-a, --add: Create a tag key=value pair
-d, --del: Delete a tag key=value pair

users (user, usr, u)¶

User recipes

scullery users [-h]
               {get,g,add,new,create,a,n,c,del,rm,d,rr,group,grp,gr,passwd,reset-passwd,password,set-passwd,pass}
               ...

Sub-commands¶

get (g)¶

Get details for user

scullery users get [-h] user [user ...]

Positional Arguments¶

user: User to look-up

add (new, create, a, n, c)¶

Add user

scullery users add [-h] [-P PASSWD] [-n NAME] [-m EMAIL] [-d DESCRIPTION]
                   [-p PROJECT] [-g GROUP]

Named Arguments¶

-P, --password, --passwd

Password to use (if not specified a random password is used)

-n, --name, --user

User name to create (it not specified a random name is used)

-m, -e, --email, --mail

Assign e-mail address

-d, --description, --desc

Description for this user

-p, --project, --proj

Include project name in description

-g, --group, --grp

Assign group (can be specified multiple times)

Default: []

del (rm, d, rr)¶

Delete user

scullery users del [-h] name [name ...]

Positional Arguments¶

name: User name to delete

group (grp, gr)¶

Modify user group membership

scullery users group [-h] group {add,del} user

Positional Arguments¶

group

Group to modify

op

Possible choices: add, del

Add or Delete operation

user

User to add/del from group

passwd (reset-passwd, password, set-passwd, pass)¶

set/reset user password

scullery users passwd [-h] [-S] user [password]

Positional Arguments¶

user: User to modify
password: Password to set (if not specify will use a random string)

Named Arguments¶

-S, --chg-pwd

Ask password to be changed on first login

Default: False