repository_name
stringlengths 5
67
| func_path_in_repository
stringlengths 4
234
| func_name
stringlengths 0
314
| whole_func_string
stringlengths 52
3.87M
| language
stringclasses 6
values | func_code_string
stringlengths 39
1.84M
| func_code_tokens
listlengths 15
672k
| func_documentation_string
stringlengths 1
47.2k
| func_documentation_tokens
listlengths 1
3.92k
| split_name
stringclasses 1
value | func_code_url
stringlengths 85
339
|
|---|---|---|---|---|---|---|---|---|---|---|
softlayer/softlayer-python | SoftLayer/CLI/user/permissions.py | roles_table | def roles_table(user):
"""Creates a table for a users roles"""
table = formatting.Table(['id', 'Role Name', 'Description'])
for role in user['roles']:
table.add_row([role['id'], role['name'], role['description']])
return table | python | def roles_table(user):
table = formatting.Table(['id', 'Role Name', 'Description'])
for role in user['roles']:
table.add_row([role['id'], role['name'], role['description']])
return table | [
"def",
"roles_table",
"(",
"user",
")",
":",
"table",
"=",
"formatting",
".",
"Table",
"(",
"[",
"'id'",
",",
"'Role Name'",
",",
"'Description'",
"]",
")",
"for",
"role",
"in",
"user",
"[",
"'roles'",
"]",
":",
"table",
".",
"add_row",
"(",
"[",
"role",
"[",
"'id'",
"]",
",",
"role",
"[",
"'name'",
"]",
",",
"role",
"[",
"'description'",
"]",
"]",
")",
"return",
"table"
]
| Creates a table for a users roles | [
"Creates",
"a",
"table",
"for",
"a",
"users",
"roles"
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/CLI/user/permissions.py#L52-L57 |
softlayer/softlayer-python | SoftLayer/CLI/virt/create.py | _update_with_like_args | def _update_with_like_args(ctx, _, value):
"""Update arguments with options taken from a currently running VS."""
if value is None:
return
env = ctx.ensure_object(environment.Environment)
vsi = SoftLayer.VSManager(env.client)
vs_id = helpers.resolve_id(vsi.resolve_ids, value, 'VS')
like_details = vsi.get_instance(vs_id)
like_args = {
'hostname': like_details['hostname'],
'domain': like_details['domain'],
'hourly': like_details['hourlyBillingFlag'],
'datacenter': like_details['datacenter']['name'],
'network': like_details['networkComponents'][0]['maxSpeed'],
'userdata': like_details['userData'] or None,
'postinstall': like_details.get('postInstallScriptUri'),
'dedicated': like_details['dedicatedAccountHostOnlyFlag'],
'private': like_details['privateNetworkOnlyFlag'],
'placement_id': like_details.get('placementGroupId', None),
}
like_args['flavor'] = utils.lookup(like_details,
'billingItem',
'orderItem',
'preset',
'keyName')
if not like_args['flavor']:
like_args['cpu'] = like_details['maxCpu']
like_args['memory'] = '%smb' % like_details['maxMemory']
tag_refs = like_details.get('tagReferences', None)
if tag_refs is not None and len(tag_refs) > 0:
like_args['tag'] = [t['tag']['name'] for t in tag_refs]
# Handle mutually exclusive options
like_image = utils.lookup(like_details,
'blockDeviceTemplateGroup',
'globalIdentifier')
like_os = utils.lookup(like_details,
'operatingSystem',
'softwareLicense',
'softwareDescription',
'referenceCode')
if like_image:
like_args['image'] = like_image
elif like_os:
like_args['os'] = like_os
if ctx.default_map is None:
ctx.default_map = {}
ctx.default_map.update(like_args) | python | def _update_with_like_args(ctx, _, value):
if value is None:
return
env = ctx.ensure_object(environment.Environment)
vsi = SoftLayer.VSManager(env.client)
vs_id = helpers.resolve_id(vsi.resolve_ids, value, 'VS')
like_details = vsi.get_instance(vs_id)
like_args = {
'hostname': like_details['hostname'],
'domain': like_details['domain'],
'hourly': like_details['hourlyBillingFlag'],
'datacenter': like_details['datacenter']['name'],
'network': like_details['networkComponents'][0]['maxSpeed'],
'userdata': like_details['userData'] or None,
'postinstall': like_details.get('postInstallScriptUri'),
'dedicated': like_details['dedicatedAccountHostOnlyFlag'],
'private': like_details['privateNetworkOnlyFlag'],
'placement_id': like_details.get('placementGroupId', None),
}
like_args['flavor'] = utils.lookup(like_details,
'billingItem',
'orderItem',
'preset',
'keyName')
if not like_args['flavor']:
like_args['cpu'] = like_details['maxCpu']
like_args['memory'] = '%smb' % like_details['maxMemory']
tag_refs = like_details.get('tagReferences', None)
if tag_refs is not None and len(tag_refs) > 0:
like_args['tag'] = [t['tag']['name'] for t in tag_refs]
like_image = utils.lookup(like_details,
'blockDeviceTemplateGroup',
'globalIdentifier')
like_os = utils.lookup(like_details,
'operatingSystem',
'softwareLicense',
'softwareDescription',
'referenceCode')
if like_image:
like_args['image'] = like_image
elif like_os:
like_args['os'] = like_os
if ctx.default_map is None:
ctx.default_map = {}
ctx.default_map.update(like_args) | [
"def",
"_update_with_like_args",
"(",
"ctx",
",",
"_",
",",
"value",
")",
":",
"if",
"value",
"is",
"None",
":",
"return",
"env",
"=",
"ctx",
".",
"ensure_object",
"(",
"environment",
".",
"Environment",
")",
"vsi",
"=",
"SoftLayer",
".",
"VSManager",
"(",
"env",
".",
"client",
")",
"vs_id",
"=",
"helpers",
".",
"resolve_id",
"(",
"vsi",
".",
"resolve_ids",
",",
"value",
",",
"'VS'",
")",
"like_details",
"=",
"vsi",
".",
"get_instance",
"(",
"vs_id",
")",
"like_args",
"=",
"{",
"'hostname'",
":",
"like_details",
"[",
"'hostname'",
"]",
",",
"'domain'",
":",
"like_details",
"[",
"'domain'",
"]",
",",
"'hourly'",
":",
"like_details",
"[",
"'hourlyBillingFlag'",
"]",
",",
"'datacenter'",
":",
"like_details",
"[",
"'datacenter'",
"]",
"[",
"'name'",
"]",
",",
"'network'",
":",
"like_details",
"[",
"'networkComponents'",
"]",
"[",
"0",
"]",
"[",
"'maxSpeed'",
"]",
",",
"'userdata'",
":",
"like_details",
"[",
"'userData'",
"]",
"or",
"None",
",",
"'postinstall'",
":",
"like_details",
".",
"get",
"(",
"'postInstallScriptUri'",
")",
",",
"'dedicated'",
":",
"like_details",
"[",
"'dedicatedAccountHostOnlyFlag'",
"]",
",",
"'private'",
":",
"like_details",
"[",
"'privateNetworkOnlyFlag'",
"]",
",",
"'placement_id'",
":",
"like_details",
".",
"get",
"(",
"'placementGroupId'",
",",
"None",
")",
",",
"}",
"like_args",
"[",
"'flavor'",
"]",
"=",
"utils",
".",
"lookup",
"(",
"like_details",
",",
"'billingItem'",
",",
"'orderItem'",
",",
"'preset'",
",",
"'keyName'",
")",
"if",
"not",
"like_args",
"[",
"'flavor'",
"]",
":",
"like_args",
"[",
"'cpu'",
"]",
"=",
"like_details",
"[",
"'maxCpu'",
"]",
"like_args",
"[",
"'memory'",
"]",
"=",
"'%smb'",
"%",
"like_details",
"[",
"'maxMemory'",
"]",
"tag_refs",
"=",
"like_details",
".",
"get",
"(",
"'tagReferences'",
",",
"None",
")",
"if",
"tag_refs",
"is",
"not",
"None",
"and",
"len",
"(",
"tag_refs",
")",
">",
"0",
":",
"like_args",
"[",
"'tag'",
"]",
"=",
"[",
"t",
"[",
"'tag'",
"]",
"[",
"'name'",
"]",
"for",
"t",
"in",
"tag_refs",
"]",
"# Handle mutually exclusive options",
"like_image",
"=",
"utils",
".",
"lookup",
"(",
"like_details",
",",
"'blockDeviceTemplateGroup'",
",",
"'globalIdentifier'",
")",
"like_os",
"=",
"utils",
".",
"lookup",
"(",
"like_details",
",",
"'operatingSystem'",
",",
"'softwareLicense'",
",",
"'softwareDescription'",
",",
"'referenceCode'",
")",
"if",
"like_image",
":",
"like_args",
"[",
"'image'",
"]",
"=",
"like_image",
"elif",
"like_os",
":",
"like_args",
"[",
"'os'",
"]",
"=",
"like_os",
"if",
"ctx",
".",
"default_map",
"is",
"None",
":",
"ctx",
".",
"default_map",
"=",
"{",
"}",
"ctx",
".",
"default_map",
".",
"update",
"(",
"like_args",
")"
]
| Update arguments with options taken from a currently running VS. | [
"Update",
"arguments",
"with",
"options",
"taken",
"from",
"a",
"currently",
"running",
"VS",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/CLI/virt/create.py#L16-L67 |
softlayer/softlayer-python | SoftLayer/CLI/virt/create.py | _parse_create_args | def _parse_create_args(client, args):
"""Converts CLI arguments to args for VSManager.create_instance.
:param dict args: CLI arguments
"""
data = {
"hourly": args.get('billing', 'hourly') == 'hourly',
"cpus": args.get('cpu', None),
"ipv6": args.get('ipv6', None),
"disks": args.get('disk', None),
"os_code": args.get('os', None),
"memory": args.get('memory', None),
"flavor": args.get('flavor', None),
"domain": args.get('domain', None),
"host_id": args.get('host_id', None),
"private": args.get('private', None),
"hostname": args.get('hostname', None),
"nic_speed": args.get('network', None),
"boot_mode": args.get('boot_mode', None),
"dedicated": args.get('dedicated', None),
"post_uri": args.get('postinstall', None),
"datacenter": args.get('datacenter', None),
"public_vlan": args.get('vlan_public', None),
"private_vlan": args.get('vlan_private', None),
"public_subnet": args.get('subnet_public', None),
"private_subnet": args.get('subnet_private', None),
}
# The primary disk is included in the flavor and the local_disk flag is not needed
# Setting it to None prevents errors from the flag not matching the flavor
if not args.get('san') and args.get('flavor'):
data['local_disk'] = None
else:
data['local_disk'] = not args.get('san')
if args.get('image'):
if args.get('image').isdigit():
image_mgr = SoftLayer.ImageManager(client)
image_details = image_mgr.get_image(args.get('image'), mask="id,globalIdentifier")
data['image_id'] = image_details['globalIdentifier']
else:
data['image_id'] = args['image']
if args.get('userdata'):
data['userdata'] = args['userdata']
elif args.get('userfile'):
with open(args['userfile'], 'r') as userfile:
data['userdata'] = userfile.read()
# Get the SSH keys
if args.get('key'):
keys = []
for key in args.get('key'):
resolver = SoftLayer.SshKeyManager(client).resolve_ids
key_id = helpers.resolve_id(resolver, key, 'SshKey')
keys.append(key_id)
data['ssh_keys'] = keys
if args.get('public_security_group'):
pub_groups = args.get('public_security_group')
data['public_security_groups'] = [group for group in pub_groups]
if args.get('private_security_group'):
priv_groups = args.get('private_security_group')
data['private_security_groups'] = [group for group in priv_groups]
if args.get('tag', False):
data['tags'] = ','.join(args['tag'])
if args.get('host_id'):
data['host_id'] = args['host_id']
if args.get('placementgroup'):
resolver = SoftLayer.managers.PlacementManager(client).resolve_ids
data['placement_id'] = helpers.resolve_id(resolver, args.get('placementgroup'), 'PlacementGroup')
return data | python | def _parse_create_args(client, args):
data = {
"hourly": args.get('billing', 'hourly') == 'hourly',
"cpus": args.get('cpu', None),
"ipv6": args.get('ipv6', None),
"disks": args.get('disk', None),
"os_code": args.get('os', None),
"memory": args.get('memory', None),
"flavor": args.get('flavor', None),
"domain": args.get('domain', None),
"host_id": args.get('host_id', None),
"private": args.get('private', None),
"hostname": args.get('hostname', None),
"nic_speed": args.get('network', None),
"boot_mode": args.get('boot_mode', None),
"dedicated": args.get('dedicated', None),
"post_uri": args.get('postinstall', None),
"datacenter": args.get('datacenter', None),
"public_vlan": args.get('vlan_public', None),
"private_vlan": args.get('vlan_private', None),
"public_subnet": args.get('subnet_public', None),
"private_subnet": args.get('subnet_private', None),
}
if not args.get('san') and args.get('flavor'):
data['local_disk'] = None
else:
data['local_disk'] = not args.get('san')
if args.get('image'):
if args.get('image').isdigit():
image_mgr = SoftLayer.ImageManager(client)
image_details = image_mgr.get_image(args.get('image'), mask="id,globalIdentifier")
data['image_id'] = image_details['globalIdentifier']
else:
data['image_id'] = args['image']
if args.get('userdata'):
data['userdata'] = args['userdata']
elif args.get('userfile'):
with open(args['userfile'], 'r') as userfile:
data['userdata'] = userfile.read()
if args.get('key'):
keys = []
for key in args.get('key'):
resolver = SoftLayer.SshKeyManager(client).resolve_ids
key_id = helpers.resolve_id(resolver, key, 'SshKey')
keys.append(key_id)
data['ssh_keys'] = keys
if args.get('public_security_group'):
pub_groups = args.get('public_security_group')
data['public_security_groups'] = [group for group in pub_groups]
if args.get('private_security_group'):
priv_groups = args.get('private_security_group')
data['private_security_groups'] = [group for group in priv_groups]
if args.get('tag', False):
data['tags'] = ','.join(args['tag'])
if args.get('host_id'):
data['host_id'] = args['host_id']
if args.get('placementgroup'):
resolver = SoftLayer.managers.PlacementManager(client).resolve_ids
data['placement_id'] = helpers.resolve_id(resolver, args.get('placementgroup'), 'PlacementGroup')
return data | [
"def",
"_parse_create_args",
"(",
"client",
",",
"args",
")",
":",
"data",
"=",
"{",
"\"hourly\"",
":",
"args",
".",
"get",
"(",
"'billing'",
",",
"'hourly'",
")",
"==",
"'hourly'",
",",
"\"cpus\"",
":",
"args",
".",
"get",
"(",
"'cpu'",
",",
"None",
")",
",",
"\"ipv6\"",
":",
"args",
".",
"get",
"(",
"'ipv6'",
",",
"None",
")",
",",
"\"disks\"",
":",
"args",
".",
"get",
"(",
"'disk'",
",",
"None",
")",
",",
"\"os_code\"",
":",
"args",
".",
"get",
"(",
"'os'",
",",
"None",
")",
",",
"\"memory\"",
":",
"args",
".",
"get",
"(",
"'memory'",
",",
"None",
")",
",",
"\"flavor\"",
":",
"args",
".",
"get",
"(",
"'flavor'",
",",
"None",
")",
",",
"\"domain\"",
":",
"args",
".",
"get",
"(",
"'domain'",
",",
"None",
")",
",",
"\"host_id\"",
":",
"args",
".",
"get",
"(",
"'host_id'",
",",
"None",
")",
",",
"\"private\"",
":",
"args",
".",
"get",
"(",
"'private'",
",",
"None",
")",
",",
"\"hostname\"",
":",
"args",
".",
"get",
"(",
"'hostname'",
",",
"None",
")",
",",
"\"nic_speed\"",
":",
"args",
".",
"get",
"(",
"'network'",
",",
"None",
")",
",",
"\"boot_mode\"",
":",
"args",
".",
"get",
"(",
"'boot_mode'",
",",
"None",
")",
",",
"\"dedicated\"",
":",
"args",
".",
"get",
"(",
"'dedicated'",
",",
"None",
")",
",",
"\"post_uri\"",
":",
"args",
".",
"get",
"(",
"'postinstall'",
",",
"None",
")",
",",
"\"datacenter\"",
":",
"args",
".",
"get",
"(",
"'datacenter'",
",",
"None",
")",
",",
"\"public_vlan\"",
":",
"args",
".",
"get",
"(",
"'vlan_public'",
",",
"None",
")",
",",
"\"private_vlan\"",
":",
"args",
".",
"get",
"(",
"'vlan_private'",
",",
"None",
")",
",",
"\"public_subnet\"",
":",
"args",
".",
"get",
"(",
"'subnet_public'",
",",
"None",
")",
",",
"\"private_subnet\"",
":",
"args",
".",
"get",
"(",
"'subnet_private'",
",",
"None",
")",
",",
"}",
"# The primary disk is included in the flavor and the local_disk flag is not needed",
"# Setting it to None prevents errors from the flag not matching the flavor",
"if",
"not",
"args",
".",
"get",
"(",
"'san'",
")",
"and",
"args",
".",
"get",
"(",
"'flavor'",
")",
":",
"data",
"[",
"'local_disk'",
"]",
"=",
"None",
"else",
":",
"data",
"[",
"'local_disk'",
"]",
"=",
"not",
"args",
".",
"get",
"(",
"'san'",
")",
"if",
"args",
".",
"get",
"(",
"'image'",
")",
":",
"if",
"args",
".",
"get",
"(",
"'image'",
")",
".",
"isdigit",
"(",
")",
":",
"image_mgr",
"=",
"SoftLayer",
".",
"ImageManager",
"(",
"client",
")",
"image_details",
"=",
"image_mgr",
".",
"get_image",
"(",
"args",
".",
"get",
"(",
"'image'",
")",
",",
"mask",
"=",
"\"id,globalIdentifier\"",
")",
"data",
"[",
"'image_id'",
"]",
"=",
"image_details",
"[",
"'globalIdentifier'",
"]",
"else",
":",
"data",
"[",
"'image_id'",
"]",
"=",
"args",
"[",
"'image'",
"]",
"if",
"args",
".",
"get",
"(",
"'userdata'",
")",
":",
"data",
"[",
"'userdata'",
"]",
"=",
"args",
"[",
"'userdata'",
"]",
"elif",
"args",
".",
"get",
"(",
"'userfile'",
")",
":",
"with",
"open",
"(",
"args",
"[",
"'userfile'",
"]",
",",
"'r'",
")",
"as",
"userfile",
":",
"data",
"[",
"'userdata'",
"]",
"=",
"userfile",
".",
"read",
"(",
")",
"# Get the SSH keys",
"if",
"args",
".",
"get",
"(",
"'key'",
")",
":",
"keys",
"=",
"[",
"]",
"for",
"key",
"in",
"args",
".",
"get",
"(",
"'key'",
")",
":",
"resolver",
"=",
"SoftLayer",
".",
"SshKeyManager",
"(",
"client",
")",
".",
"resolve_ids",
"key_id",
"=",
"helpers",
".",
"resolve_id",
"(",
"resolver",
",",
"key",
",",
"'SshKey'",
")",
"keys",
".",
"append",
"(",
"key_id",
")",
"data",
"[",
"'ssh_keys'",
"]",
"=",
"keys",
"if",
"args",
".",
"get",
"(",
"'public_security_group'",
")",
":",
"pub_groups",
"=",
"args",
".",
"get",
"(",
"'public_security_group'",
")",
"data",
"[",
"'public_security_groups'",
"]",
"=",
"[",
"group",
"for",
"group",
"in",
"pub_groups",
"]",
"if",
"args",
".",
"get",
"(",
"'private_security_group'",
")",
":",
"priv_groups",
"=",
"args",
".",
"get",
"(",
"'private_security_group'",
")",
"data",
"[",
"'private_security_groups'",
"]",
"=",
"[",
"group",
"for",
"group",
"in",
"priv_groups",
"]",
"if",
"args",
".",
"get",
"(",
"'tag'",
",",
"False",
")",
":",
"data",
"[",
"'tags'",
"]",
"=",
"','",
".",
"join",
"(",
"args",
"[",
"'tag'",
"]",
")",
"if",
"args",
".",
"get",
"(",
"'host_id'",
")",
":",
"data",
"[",
"'host_id'",
"]",
"=",
"args",
"[",
"'host_id'",
"]",
"if",
"args",
".",
"get",
"(",
"'placementgroup'",
")",
":",
"resolver",
"=",
"SoftLayer",
".",
"managers",
".",
"PlacementManager",
"(",
"client",
")",
".",
"resolve_ids",
"data",
"[",
"'placement_id'",
"]",
"=",
"helpers",
".",
"resolve_id",
"(",
"resolver",
",",
"args",
".",
"get",
"(",
"'placementgroup'",
")",
",",
"'PlacementGroup'",
")",
"return",
"data"
]
| Converts CLI arguments to args for VSManager.create_instance.
:param dict args: CLI arguments | [
"Converts",
"CLI",
"arguments",
"to",
"args",
"for",
"VSManager",
".",
"create_instance",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/CLI/virt/create.py#L70-L146 |
softlayer/softlayer-python | SoftLayer/CLI/virt/create.py | cli | def cli(env, **args):
"""Order/create virtual servers."""
vsi = SoftLayer.VSManager(env.client)
_validate_args(env, args)
create_args = _parse_create_args(env.client, args)
test = args.get('test', False)
do_create = not (args.get('export') or test)
if do_create:
if not (env.skip_confirmations or formatting.confirm(
"This action will incur charges on your account. Continue?")):
raise exceptions.CLIAbort('Aborting virtual server order.')
if args.get('export'):
export_file = args.pop('export')
template.export_to_template(export_file, args, exclude=['wait', 'test'])
env.fout('Successfully exported options to a template file.')
else:
result = vsi.order_guest(create_args, test)
output = _build_receipt_table(result, args.get('billing'), test)
if do_create:
env.fout(_build_guest_table(result))
env.fout(output)
if args.get('wait'):
virtual_guests = utils.lookup(result, 'orderDetails', 'virtualGuests')
guest_id = virtual_guests[0]['id']
click.secho("Waiting for %s to finish provisioning..." % guest_id, fg='green')
ready = vsi.wait_for_ready(guest_id, args.get('wait') or 1)
if ready is False:
env.out(env.fmt(output))
raise exceptions.CLIHalt(code=1) | python | def cli(env, **args):
vsi = SoftLayer.VSManager(env.client)
_validate_args(env, args)
create_args = _parse_create_args(env.client, args)
test = args.get('test', False)
do_create = not (args.get('export') or test)
if do_create:
if not (env.skip_confirmations or formatting.confirm(
"This action will incur charges on your account. Continue?")):
raise exceptions.CLIAbort('Aborting virtual server order.')
if args.get('export'):
export_file = args.pop('export')
template.export_to_template(export_file, args, exclude=['wait', 'test'])
env.fout('Successfully exported options to a template file.')
else:
result = vsi.order_guest(create_args, test)
output = _build_receipt_table(result, args.get('billing'), test)
if do_create:
env.fout(_build_guest_table(result))
env.fout(output)
if args.get('wait'):
virtual_guests = utils.lookup(result, 'orderDetails', 'virtualGuests')
guest_id = virtual_guests[0]['id']
click.secho("Waiting for %s to finish provisioning..." % guest_id, fg='green')
ready = vsi.wait_for_ready(guest_id, args.get('wait') or 1)
if ready is False:
env.out(env.fmt(output))
raise exceptions.CLIHalt(code=1) | [
"def",
"cli",
"(",
"env",
",",
"*",
"*",
"args",
")",
":",
"vsi",
"=",
"SoftLayer",
".",
"VSManager",
"(",
"env",
".",
"client",
")",
"_validate_args",
"(",
"env",
",",
"args",
")",
"create_args",
"=",
"_parse_create_args",
"(",
"env",
".",
"client",
",",
"args",
")",
"test",
"=",
"args",
".",
"get",
"(",
"'test'",
",",
"False",
")",
"do_create",
"=",
"not",
"(",
"args",
".",
"get",
"(",
"'export'",
")",
"or",
"test",
")",
"if",
"do_create",
":",
"if",
"not",
"(",
"env",
".",
"skip_confirmations",
"or",
"formatting",
".",
"confirm",
"(",
"\"This action will incur charges on your account. Continue?\"",
")",
")",
":",
"raise",
"exceptions",
".",
"CLIAbort",
"(",
"'Aborting virtual server order.'",
")",
"if",
"args",
".",
"get",
"(",
"'export'",
")",
":",
"export_file",
"=",
"args",
".",
"pop",
"(",
"'export'",
")",
"template",
".",
"export_to_template",
"(",
"export_file",
",",
"args",
",",
"exclude",
"=",
"[",
"'wait'",
",",
"'test'",
"]",
")",
"env",
".",
"fout",
"(",
"'Successfully exported options to a template file.'",
")",
"else",
":",
"result",
"=",
"vsi",
".",
"order_guest",
"(",
"create_args",
",",
"test",
")",
"output",
"=",
"_build_receipt_table",
"(",
"result",
",",
"args",
".",
"get",
"(",
"'billing'",
")",
",",
"test",
")",
"if",
"do_create",
":",
"env",
".",
"fout",
"(",
"_build_guest_table",
"(",
"result",
")",
")",
"env",
".",
"fout",
"(",
"output",
")",
"if",
"args",
".",
"get",
"(",
"'wait'",
")",
":",
"virtual_guests",
"=",
"utils",
".",
"lookup",
"(",
"result",
",",
"'orderDetails'",
",",
"'virtualGuests'",
")",
"guest_id",
"=",
"virtual_guests",
"[",
"0",
"]",
"[",
"'id'",
"]",
"click",
".",
"secho",
"(",
"\"Waiting for %s to finish provisioning...\"",
"%",
"guest_id",
",",
"fg",
"=",
"'green'",
")",
"ready",
"=",
"vsi",
".",
"wait_for_ready",
"(",
"guest_id",
",",
"args",
".",
"get",
"(",
"'wait'",
")",
"or",
"1",
")",
"if",
"ready",
"is",
"False",
":",
"env",
".",
"out",
"(",
"env",
".",
"fmt",
"(",
"output",
")",
")",
"raise",
"exceptions",
".",
"CLIHalt",
"(",
"code",
"=",
"1",
")"
]
| Order/create virtual servers. | [
"Order",
"/",
"create",
"virtual",
"servers",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/CLI/virt/create.py#L202-L236 |
softlayer/softlayer-python | SoftLayer/CLI/virt/create.py | _build_receipt_table | def _build_receipt_table(result, billing="hourly", test=False):
"""Retrieve the total recurring fee of the items prices"""
title = "OrderId: %s" % (result.get('orderId', 'No order placed'))
table = formatting.Table(['Cost', 'Description'], title=title)
table.align['Cost'] = 'r'
table.align['Description'] = 'l'
total = 0.000
if test:
prices = result['prices']
else:
prices = result['orderDetails']['prices']
for item in prices:
rate = 0.000
if billing == "hourly":
rate += float(item.get('hourlyRecurringFee', 0.000))
else:
rate += float(item.get('recurringFee', 0.000))
total += rate
table.add_row([rate, item['item']['description']])
table.add_row(["%.3f" % total, "Total %s cost" % billing])
return table | python | def _build_receipt_table(result, billing="hourly", test=False):
title = "OrderId: %s" % (result.get('orderId', 'No order placed'))
table = formatting.Table(['Cost', 'Description'], title=title)
table.align['Cost'] = 'r'
table.align['Description'] = 'l'
total = 0.000
if test:
prices = result['prices']
else:
prices = result['orderDetails']['prices']
for item in prices:
rate = 0.000
if billing == "hourly":
rate += float(item.get('hourlyRecurringFee', 0.000))
else:
rate += float(item.get('recurringFee', 0.000))
total += rate
table.add_row([rate, item['item']['description']])
table.add_row(["%.3f" % total, "Total %s cost" % billing])
return table | [
"def",
"_build_receipt_table",
"(",
"result",
",",
"billing",
"=",
"\"hourly\"",
",",
"test",
"=",
"False",
")",
":",
"title",
"=",
"\"OrderId: %s\"",
"%",
"(",
"result",
".",
"get",
"(",
"'orderId'",
",",
"'No order placed'",
")",
")",
"table",
"=",
"formatting",
".",
"Table",
"(",
"[",
"'Cost'",
",",
"'Description'",
"]",
",",
"title",
"=",
"title",
")",
"table",
".",
"align",
"[",
"'Cost'",
"]",
"=",
"'r'",
"table",
".",
"align",
"[",
"'Description'",
"]",
"=",
"'l'",
"total",
"=",
"0.000",
"if",
"test",
":",
"prices",
"=",
"result",
"[",
"'prices'",
"]",
"else",
":",
"prices",
"=",
"result",
"[",
"'orderDetails'",
"]",
"[",
"'prices'",
"]",
"for",
"item",
"in",
"prices",
":",
"rate",
"=",
"0.000",
"if",
"billing",
"==",
"\"hourly\"",
":",
"rate",
"+=",
"float",
"(",
"item",
".",
"get",
"(",
"'hourlyRecurringFee'",
",",
"0.000",
")",
")",
"else",
":",
"rate",
"+=",
"float",
"(",
"item",
".",
"get",
"(",
"'recurringFee'",
",",
"0.000",
")",
")",
"total",
"+=",
"rate",
"table",
".",
"add_row",
"(",
"[",
"rate",
",",
"item",
"[",
"'item'",
"]",
"[",
"'description'",
"]",
"]",
")",
"table",
".",
"add_row",
"(",
"[",
"\"%.3f\"",
"%",
"total",
",",
"\"Total %s cost\"",
"%",
"billing",
"]",
")",
"return",
"table"
]
| Retrieve the total recurring fee of the items prices | [
"Retrieve",
"the",
"total",
"recurring",
"fee",
"of",
"the",
"items",
"prices"
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/CLI/virt/create.py#L239-L260 |
softlayer/softlayer-python | SoftLayer/CLI/virt/create.py | _validate_args | def _validate_args(env, args):
"""Raises an ArgumentError if the given arguments are not valid."""
if all([args['cpu'], args['flavor']]):
raise exceptions.ArgumentError(
'[-c | --cpu] not allowed with [-f | --flavor]')
if all([args['memory'], args['flavor']]):
raise exceptions.ArgumentError(
'[-m | --memory] not allowed with [-f | --flavor]')
if all([args['dedicated'], args['flavor']]):
raise exceptions.ArgumentError(
'[-d | --dedicated] not allowed with [-f | --flavor]')
if all([args['host_id'], args['flavor']]):
raise exceptions.ArgumentError(
'[-h | --host-id] not allowed with [-f | --flavor]')
if all([args['userdata'], args['userfile']]):
raise exceptions.ArgumentError(
'[-u | --userdata] not allowed with [-F | --userfile]')
image_args = [args['os'], args['image']]
if all(image_args):
raise exceptions.ArgumentError(
'[-o | --os] not allowed with [--image]')
while not any([args['os'], args['image']]):
args['os'] = env.input("Operating System Code", default="", show_default=False)
if not args['os']:
args['image'] = env.input("Image", default="", show_default=False) | python | def _validate_args(env, args):
if all([args['cpu'], args['flavor']]):
raise exceptions.ArgumentError(
'[-c | --cpu] not allowed with [-f | --flavor]')
if all([args['memory'], args['flavor']]):
raise exceptions.ArgumentError(
'[-m | --memory] not allowed with [-f | --flavor]')
if all([args['dedicated'], args['flavor']]):
raise exceptions.ArgumentError(
'[-d | --dedicated] not allowed with [-f | --flavor]')
if all([args['host_id'], args['flavor']]):
raise exceptions.ArgumentError(
'[-h | --host-id] not allowed with [-f | --flavor]')
if all([args['userdata'], args['userfile']]):
raise exceptions.ArgumentError(
'[-u | --userdata] not allowed with [-F | --userfile]')
image_args = [args['os'], args['image']]
if all(image_args):
raise exceptions.ArgumentError(
'[-o | --os] not allowed with [--image]')
while not any([args['os'], args['image']]):
args['os'] = env.input("Operating System Code", default="", show_default=False)
if not args['os']:
args['image'] = env.input("Image", default="", show_default=False) | [
"def",
"_validate_args",
"(",
"env",
",",
"args",
")",
":",
"if",
"all",
"(",
"[",
"args",
"[",
"'cpu'",
"]",
",",
"args",
"[",
"'flavor'",
"]",
"]",
")",
":",
"raise",
"exceptions",
".",
"ArgumentError",
"(",
"'[-c | --cpu] not allowed with [-f | --flavor]'",
")",
"if",
"all",
"(",
"[",
"args",
"[",
"'memory'",
"]",
",",
"args",
"[",
"'flavor'",
"]",
"]",
")",
":",
"raise",
"exceptions",
".",
"ArgumentError",
"(",
"'[-m | --memory] not allowed with [-f | --flavor]'",
")",
"if",
"all",
"(",
"[",
"args",
"[",
"'dedicated'",
"]",
",",
"args",
"[",
"'flavor'",
"]",
"]",
")",
":",
"raise",
"exceptions",
".",
"ArgumentError",
"(",
"'[-d | --dedicated] not allowed with [-f | --flavor]'",
")",
"if",
"all",
"(",
"[",
"args",
"[",
"'host_id'",
"]",
",",
"args",
"[",
"'flavor'",
"]",
"]",
")",
":",
"raise",
"exceptions",
".",
"ArgumentError",
"(",
"'[-h | --host-id] not allowed with [-f | --flavor]'",
")",
"if",
"all",
"(",
"[",
"args",
"[",
"'userdata'",
"]",
",",
"args",
"[",
"'userfile'",
"]",
"]",
")",
":",
"raise",
"exceptions",
".",
"ArgumentError",
"(",
"'[-u | --userdata] not allowed with [-F | --userfile]'",
")",
"image_args",
"=",
"[",
"args",
"[",
"'os'",
"]",
",",
"args",
"[",
"'image'",
"]",
"]",
"if",
"all",
"(",
"image_args",
")",
":",
"raise",
"exceptions",
".",
"ArgumentError",
"(",
"'[-o | --os] not allowed with [--image]'",
")",
"while",
"not",
"any",
"(",
"[",
"args",
"[",
"'os'",
"]",
",",
"args",
"[",
"'image'",
"]",
"]",
")",
":",
"args",
"[",
"'os'",
"]",
"=",
"env",
".",
"input",
"(",
"\"Operating System Code\"",
",",
"default",
"=",
"\"\"",
",",
"show_default",
"=",
"False",
")",
"if",
"not",
"args",
"[",
"'os'",
"]",
":",
"args",
"[",
"'image'",
"]",
"=",
"env",
".",
"input",
"(",
"\"Image\"",
",",
"default",
"=",
"\"\"",
",",
"show_default",
"=",
"False",
")"
]
| Raises an ArgumentError if the given arguments are not valid. | [
"Raises",
"an",
"ArgumentError",
"if",
"the",
"given",
"arguments",
"are",
"not",
"valid",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/CLI/virt/create.py#L273-L304 |
softlayer/softlayer-python | SoftLayer/CLI/virt/upgrade.py | cli | def cli(env, identifier, cpu, private, memory, network, flavor):
"""Upgrade a virtual server."""
vsi = SoftLayer.VSManager(env.client)
if not any([cpu, memory, network, flavor]):
raise exceptions.ArgumentError("Must provide [--cpu], [--memory], [--network], or [--flavor] to upgrade")
if private and not cpu:
raise exceptions.ArgumentError("Must specify [--cpu] when using [--private]")
vs_id = helpers.resolve_id(vsi.resolve_ids, identifier, 'VS')
if not (env.skip_confirmations or formatting.confirm("This action will incur charges on your account. Continue?")):
raise exceptions.CLIAbort('Aborted')
if memory:
memory = int(memory / 1024)
if not vsi.upgrade(vs_id, cpus=cpu, memory=memory, nic_speed=network, public=not private, preset=flavor):
raise exceptions.CLIAbort('VS Upgrade Failed') | python | def cli(env, identifier, cpu, private, memory, network, flavor):
vsi = SoftLayer.VSManager(env.client)
if not any([cpu, memory, network, flavor]):
raise exceptions.ArgumentError("Must provide [--cpu], [--memory], [--network], or [--flavor] to upgrade")
if private and not cpu:
raise exceptions.ArgumentError("Must specify [--cpu] when using [--private]")
vs_id = helpers.resolve_id(vsi.resolve_ids, identifier, 'VS')
if not (env.skip_confirmations or formatting.confirm("This action will incur charges on your account. Continue?")):
raise exceptions.CLIAbort('Aborted')
if memory:
memory = int(memory / 1024)
if not vsi.upgrade(vs_id, cpus=cpu, memory=memory, nic_speed=network, public=not private, preset=flavor):
raise exceptions.CLIAbort('VS Upgrade Failed') | [
"def",
"cli",
"(",
"env",
",",
"identifier",
",",
"cpu",
",",
"private",
",",
"memory",
",",
"network",
",",
"flavor",
")",
":",
"vsi",
"=",
"SoftLayer",
".",
"VSManager",
"(",
"env",
".",
"client",
")",
"if",
"not",
"any",
"(",
"[",
"cpu",
",",
"memory",
",",
"network",
",",
"flavor",
"]",
")",
":",
"raise",
"exceptions",
".",
"ArgumentError",
"(",
"\"Must provide [--cpu], [--memory], [--network], or [--flavor] to upgrade\"",
")",
"if",
"private",
"and",
"not",
"cpu",
":",
"raise",
"exceptions",
".",
"ArgumentError",
"(",
"\"Must specify [--cpu] when using [--private]\"",
")",
"vs_id",
"=",
"helpers",
".",
"resolve_id",
"(",
"vsi",
".",
"resolve_ids",
",",
"identifier",
",",
"'VS'",
")",
"if",
"not",
"(",
"env",
".",
"skip_confirmations",
"or",
"formatting",
".",
"confirm",
"(",
"\"This action will incur charges on your account. Continue?\"",
")",
")",
":",
"raise",
"exceptions",
".",
"CLIAbort",
"(",
"'Aborted'",
")",
"if",
"memory",
":",
"memory",
"=",
"int",
"(",
"memory",
"/",
"1024",
")",
"if",
"not",
"vsi",
".",
"upgrade",
"(",
"vs_id",
",",
"cpus",
"=",
"cpu",
",",
"memory",
"=",
"memory",
",",
"nic_speed",
"=",
"network",
",",
"public",
"=",
"not",
"private",
",",
"preset",
"=",
"flavor",
")",
":",
"raise",
"exceptions",
".",
"CLIAbort",
"(",
"'VS Upgrade Failed'",
")"
]
| Upgrade a virtual server. | [
"Upgrade",
"a",
"virtual",
"server",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/CLI/virt/upgrade.py#L26-L45 |
softlayer/softlayer-python | SoftLayer/CLI/hardware/power.py | reboot | def reboot(env, identifier, hard):
"""Reboot an active server."""
hardware_server = env.client['Hardware_Server']
mgr = SoftLayer.HardwareManager(env.client)
hw_id = helpers.resolve_id(mgr.resolve_ids, identifier, 'hardware')
if not (env.skip_confirmations or
formatting.confirm('This will power off the server with id %s. '
'Continue?' % hw_id)):
raise exceptions.CLIAbort('Aborted.')
if hard is True:
hardware_server.rebootHard(id=hw_id)
elif hard is False:
hardware_server.rebootSoft(id=hw_id)
else:
hardware_server.rebootDefault(id=hw_id) | python | def reboot(env, identifier, hard):
hardware_server = env.client['Hardware_Server']
mgr = SoftLayer.HardwareManager(env.client)
hw_id = helpers.resolve_id(mgr.resolve_ids, identifier, 'hardware')
if not (env.skip_confirmations or
formatting.confirm('This will power off the server with id %s. '
'Continue?' % hw_id)):
raise exceptions.CLIAbort('Aborted.')
if hard is True:
hardware_server.rebootHard(id=hw_id)
elif hard is False:
hardware_server.rebootSoft(id=hw_id)
else:
hardware_server.rebootDefault(id=hw_id) | [
"def",
"reboot",
"(",
"env",
",",
"identifier",
",",
"hard",
")",
":",
"hardware_server",
"=",
"env",
".",
"client",
"[",
"'Hardware_Server'",
"]",
"mgr",
"=",
"SoftLayer",
".",
"HardwareManager",
"(",
"env",
".",
"client",
")",
"hw_id",
"=",
"helpers",
".",
"resolve_id",
"(",
"mgr",
".",
"resolve_ids",
",",
"identifier",
",",
"'hardware'",
")",
"if",
"not",
"(",
"env",
".",
"skip_confirmations",
"or",
"formatting",
".",
"confirm",
"(",
"'This will power off the server with id %s. '",
"'Continue?'",
"%",
"hw_id",
")",
")",
":",
"raise",
"exceptions",
".",
"CLIAbort",
"(",
"'Aborted.'",
")",
"if",
"hard",
"is",
"True",
":",
"hardware_server",
".",
"rebootHard",
"(",
"id",
"=",
"hw_id",
")",
"elif",
"hard",
"is",
"False",
":",
"hardware_server",
".",
"rebootSoft",
"(",
"id",
"=",
"hw_id",
")",
"else",
":",
"hardware_server",
".",
"rebootDefault",
"(",
"id",
"=",
"hw_id",
")"
]
| Reboot an active server. | [
"Reboot",
"an",
"active",
"server",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/CLI/hardware/power.py#L35-L51 |
softlayer/softlayer-python | SoftLayer/CLI/hardware/power.py | power_on | def power_on(env, identifier):
"""Power on a server."""
mgr = SoftLayer.HardwareManager(env.client)
hw_id = helpers.resolve_id(mgr.resolve_ids, identifier, 'hardware')
env.client['Hardware_Server'].powerOn(id=hw_id) | python | def power_on(env, identifier):
mgr = SoftLayer.HardwareManager(env.client)
hw_id = helpers.resolve_id(mgr.resolve_ids, identifier, 'hardware')
env.client['Hardware_Server'].powerOn(id=hw_id) | [
"def",
"power_on",
"(",
"env",
",",
"identifier",
")",
":",
"mgr",
"=",
"SoftLayer",
".",
"HardwareManager",
"(",
"env",
".",
"client",
")",
"hw_id",
"=",
"helpers",
".",
"resolve_id",
"(",
"mgr",
".",
"resolve_ids",
",",
"identifier",
",",
"'hardware'",
")",
"env",
".",
"client",
"[",
"'Hardware_Server'",
"]",
".",
"powerOn",
"(",
"id",
"=",
"hw_id",
")"
]
| Power on a server. | [
"Power",
"on",
"a",
"server",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/CLI/hardware/power.py#L57-L62 |
softlayer/softlayer-python | SoftLayer/CLI/hardware/power.py | power_cycle | def power_cycle(env, identifier):
"""Power cycle a server."""
mgr = SoftLayer.HardwareManager(env.client)
hw_id = helpers.resolve_id(mgr.resolve_ids, identifier, 'hardware')
if not (env.skip_confirmations or
formatting.confirm('This will power off the server with id %s. '
'Continue?' % hw_id)):
raise exceptions.CLIAbort('Aborted.')
env.client['Hardware_Server'].powerCycle(id=hw_id) | python | def power_cycle(env, identifier):
mgr = SoftLayer.HardwareManager(env.client)
hw_id = helpers.resolve_id(mgr.resolve_ids, identifier, 'hardware')
if not (env.skip_confirmations or
formatting.confirm('This will power off the server with id %s. '
'Continue?' % hw_id)):
raise exceptions.CLIAbort('Aborted.')
env.client['Hardware_Server'].powerCycle(id=hw_id) | [
"def",
"power_cycle",
"(",
"env",
",",
"identifier",
")",
":",
"mgr",
"=",
"SoftLayer",
".",
"HardwareManager",
"(",
"env",
".",
"client",
")",
"hw_id",
"=",
"helpers",
".",
"resolve_id",
"(",
"mgr",
".",
"resolve_ids",
",",
"identifier",
",",
"'hardware'",
")",
"if",
"not",
"(",
"env",
".",
"skip_confirmations",
"or",
"formatting",
".",
"confirm",
"(",
"'This will power off the server with id %s. '",
"'Continue?'",
"%",
"hw_id",
")",
")",
":",
"raise",
"exceptions",
".",
"CLIAbort",
"(",
"'Aborted.'",
")",
"env",
".",
"client",
"[",
"'Hardware_Server'",
"]",
".",
"powerCycle",
"(",
"id",
"=",
"hw_id",
")"
]
| Power cycle a server. | [
"Power",
"cycle",
"a",
"server",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/CLI/hardware/power.py#L68-L79 |
softlayer/softlayer-python | SoftLayer/CLI/securitygroup/edit.py | cli | def cli(env, group_id, name, description):
"""Edit details of a security group."""
mgr = SoftLayer.NetworkManager(env.client)
data = {}
if name:
data['name'] = name
if description:
data['description'] = description
if not mgr.edit_securitygroup(group_id, **data):
raise exceptions.CLIAbort("Failed to edit security group") | python | def cli(env, group_id, name, description):
mgr = SoftLayer.NetworkManager(env.client)
data = {}
if name:
data['name'] = name
if description:
data['description'] = description
if not mgr.edit_securitygroup(group_id, **data):
raise exceptions.CLIAbort("Failed to edit security group") | [
"def",
"cli",
"(",
"env",
",",
"group_id",
",",
"name",
",",
"description",
")",
":",
"mgr",
"=",
"SoftLayer",
".",
"NetworkManager",
"(",
"env",
".",
"client",
")",
"data",
"=",
"{",
"}",
"if",
"name",
":",
"data",
"[",
"'name'",
"]",
"=",
"name",
"if",
"description",
":",
"data",
"[",
"'description'",
"]",
"=",
"description",
"if",
"not",
"mgr",
".",
"edit_securitygroup",
"(",
"group_id",
",",
"*",
"*",
"data",
")",
":",
"raise",
"exceptions",
".",
"CLIAbort",
"(",
"\"Failed to edit security group\"",
")"
]
| Edit details of a security group. | [
"Edit",
"details",
"of",
"a",
"security",
"group",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/CLI/securitygroup/edit.py#L18-L28 |
softlayer/softlayer-python | SoftLayer/CLI/sshkey/list.py | cli | def cli(env, sortby):
"""List SSH keys."""
mgr = SoftLayer.SshKeyManager(env.client)
keys = mgr.list_keys()
table = formatting.Table(['id', 'label', 'fingerprint', 'notes'])
table.sortby = sortby
for key in keys:
table.add_row([key['id'],
key.get('label'),
key.get('fingerprint'),
key.get('notes', '-')])
env.fout(table) | python | def cli(env, sortby):
mgr = SoftLayer.SshKeyManager(env.client)
keys = mgr.list_keys()
table = formatting.Table(['id', 'label', 'fingerprint', 'notes'])
table.sortby = sortby
for key in keys:
table.add_row([key['id'],
key.get('label'),
key.get('fingerprint'),
key.get('notes', '-')])
env.fout(table) | [
"def",
"cli",
"(",
"env",
",",
"sortby",
")",
":",
"mgr",
"=",
"SoftLayer",
".",
"SshKeyManager",
"(",
"env",
".",
"client",
")",
"keys",
"=",
"mgr",
".",
"list_keys",
"(",
")",
"table",
"=",
"formatting",
".",
"Table",
"(",
"[",
"'id'",
",",
"'label'",
",",
"'fingerprint'",
",",
"'notes'",
"]",
")",
"table",
".",
"sortby",
"=",
"sortby",
"for",
"key",
"in",
"keys",
":",
"table",
".",
"add_row",
"(",
"[",
"key",
"[",
"'id'",
"]",
",",
"key",
".",
"get",
"(",
"'label'",
")",
",",
"key",
".",
"get",
"(",
"'fingerprint'",
")",
",",
"key",
".",
"get",
"(",
"'notes'",
",",
"'-'",
")",
"]",
")",
"env",
".",
"fout",
"(",
"table",
")"
]
| List SSH keys. | [
"List",
"SSH",
"keys",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/CLI/sshkey/list.py#L19-L34 |
softlayer/softlayer-python | SoftLayer/CLI/event_log/get.py | cli | def cli(env, date_min, date_max, obj_event, obj_id, obj_type, utc_offset, metadata, limit):
"""Get Event Logs
Example:
slcli event-log get -d 01/01/2019 -D 02/01/2019 -t User -l 10
"""
columns = ['Event', 'Object', 'Type', 'Date', 'Username']
event_mgr = SoftLayer.EventLogManager(env.client)
user_mgr = SoftLayer.UserManager(env.client)
request_filter = event_mgr.build_filter(date_min, date_max, obj_event, obj_id, obj_type, utc_offset)
logs = event_mgr.get_event_logs(request_filter)
log_time = "%Y-%m-%dT%H:%M:%S.%f%z"
user_data = {}
if metadata:
columns.append('Metadata')
row_count = 0
click.secho(", ".join(columns))
for log in logs:
if log is None:
click.secho('No logs available for filter %s.' % request_filter, fg='red')
return
user = log['userType']
label = log.get('label', '')
if user == "CUSTOMER":
username = user_data.get(log['userId'])
if username is None:
username = user_mgr.get_user(log['userId'], "mask[username]")['username']
user_data[log['userId']] = username
user = username
if metadata:
metadata_data = log['metaData'].strip("\n\t")
click.secho("'{0}','{1}','{2}','{3}','{4}','{5}'".format(
log['eventName'],
label,
log['objectName'],
utils.clean_time(log['eventCreateDate'], in_format=log_time),
user,
metadata_data))
else:
click.secho("'{0}','{1}','{2}','{3}','{4}'".format(
log['eventName'],
label,
log['objectName'],
utils.clean_time(log['eventCreateDate'], in_format=log_time),
user))
row_count = row_count + 1
if row_count >= limit and limit != -1:
return | python | def cli(env, date_min, date_max, obj_event, obj_id, obj_type, utc_offset, metadata, limit):
columns = ['Event', 'Object', 'Type', 'Date', 'Username']
event_mgr = SoftLayer.EventLogManager(env.client)
user_mgr = SoftLayer.UserManager(env.client)
request_filter = event_mgr.build_filter(date_min, date_max, obj_event, obj_id, obj_type, utc_offset)
logs = event_mgr.get_event_logs(request_filter)
log_time = "%Y-%m-%dT%H:%M:%S.%f%z"
user_data = {}
if metadata:
columns.append('Metadata')
row_count = 0
click.secho(", ".join(columns))
for log in logs:
if log is None:
click.secho('No logs available for filter %s.' % request_filter, fg='red')
return
user = log['userType']
label = log.get('label', '')
if user == "CUSTOMER":
username = user_data.get(log['userId'])
if username is None:
username = user_mgr.get_user(log['userId'], "mask[username]")['username']
user_data[log['userId']] = username
user = username
if metadata:
metadata_data = log['metaData'].strip("\n\t")
click.secho("'{0}','{1}','{2}','{3}','{4}','{5}'".format(
log['eventName'],
label,
log['objectName'],
utils.clean_time(log['eventCreateDate'], in_format=log_time),
user,
metadata_data))
else:
click.secho("'{0}','{1}','{2}','{3}','{4}'".format(
log['eventName'],
label,
log['objectName'],
utils.clean_time(log['eventCreateDate'], in_format=log_time),
user))
row_count = row_count + 1
if row_count >= limit and limit != -1:
return | [
"def",
"cli",
"(",
"env",
",",
"date_min",
",",
"date_max",
",",
"obj_event",
",",
"obj_id",
",",
"obj_type",
",",
"utc_offset",
",",
"metadata",
",",
"limit",
")",
":",
"columns",
"=",
"[",
"'Event'",
",",
"'Object'",
",",
"'Type'",
",",
"'Date'",
",",
"'Username'",
"]",
"event_mgr",
"=",
"SoftLayer",
".",
"EventLogManager",
"(",
"env",
".",
"client",
")",
"user_mgr",
"=",
"SoftLayer",
".",
"UserManager",
"(",
"env",
".",
"client",
")",
"request_filter",
"=",
"event_mgr",
".",
"build_filter",
"(",
"date_min",
",",
"date_max",
",",
"obj_event",
",",
"obj_id",
",",
"obj_type",
",",
"utc_offset",
")",
"logs",
"=",
"event_mgr",
".",
"get_event_logs",
"(",
"request_filter",
")",
"log_time",
"=",
"\"%Y-%m-%dT%H:%M:%S.%f%z\"",
"user_data",
"=",
"{",
"}",
"if",
"metadata",
":",
"columns",
".",
"append",
"(",
"'Metadata'",
")",
"row_count",
"=",
"0",
"click",
".",
"secho",
"(",
"\", \"",
".",
"join",
"(",
"columns",
")",
")",
"for",
"log",
"in",
"logs",
":",
"if",
"log",
"is",
"None",
":",
"click",
".",
"secho",
"(",
"'No logs available for filter %s.'",
"%",
"request_filter",
",",
"fg",
"=",
"'red'",
")",
"return",
"user",
"=",
"log",
"[",
"'userType'",
"]",
"label",
"=",
"log",
".",
"get",
"(",
"'label'",
",",
"''",
")",
"if",
"user",
"==",
"\"CUSTOMER\"",
":",
"username",
"=",
"user_data",
".",
"get",
"(",
"log",
"[",
"'userId'",
"]",
")",
"if",
"username",
"is",
"None",
":",
"username",
"=",
"user_mgr",
".",
"get_user",
"(",
"log",
"[",
"'userId'",
"]",
",",
"\"mask[username]\"",
")",
"[",
"'username'",
"]",
"user_data",
"[",
"log",
"[",
"'userId'",
"]",
"]",
"=",
"username",
"user",
"=",
"username",
"if",
"metadata",
":",
"metadata_data",
"=",
"log",
"[",
"'metaData'",
"]",
".",
"strip",
"(",
"\"\\n\\t\"",
")",
"click",
".",
"secho",
"(",
"\"'{0}','{1}','{2}','{3}','{4}','{5}'\"",
".",
"format",
"(",
"log",
"[",
"'eventName'",
"]",
",",
"label",
",",
"log",
"[",
"'objectName'",
"]",
",",
"utils",
".",
"clean_time",
"(",
"log",
"[",
"'eventCreateDate'",
"]",
",",
"in_format",
"=",
"log_time",
")",
",",
"user",
",",
"metadata_data",
")",
")",
"else",
":",
"click",
".",
"secho",
"(",
"\"'{0}','{1}','{2}','{3}','{4}'\"",
".",
"format",
"(",
"log",
"[",
"'eventName'",
"]",
",",
"label",
",",
"log",
"[",
"'objectName'",
"]",
",",
"utils",
".",
"clean_time",
"(",
"log",
"[",
"'eventCreateDate'",
"]",
",",
"in_format",
"=",
"log_time",
")",
",",
"user",
")",
")",
"row_count",
"=",
"row_count",
"+",
"1",
"if",
"row_count",
">=",
"limit",
"and",
"limit",
"!=",
"-",
"1",
":",
"return"
]
| Get Event Logs
Example:
slcli event-log get -d 01/01/2019 -D 02/01/2019 -t User -l 10 | [
"Get",
"Event",
"Logs"
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/CLI/event_log/get.py#L29-L83 |
softlayer/softlayer-python | SoftLayer/CLI/file/modify.py | cli | def cli(env, volume_id, new_size, new_iops, new_tier):
"""Modify an existing file storage volume."""
file_manager = SoftLayer.FileStorageManager(env.client)
if new_tier is not None:
new_tier = float(new_tier)
try:
order = file_manager.order_modified_volume(
volume_id,
new_size=new_size,
new_iops=new_iops,
new_tier_level=new_tier,
)
except ValueError as ex:
raise exceptions.ArgumentError(str(ex))
if 'placedOrder' in order.keys():
click.echo("Order #{0} placed successfully!".format(order['placedOrder']['id']))
for item in order['placedOrder']['items']:
click.echo(" > %s" % item['description'])
else:
click.echo("Order could not be placed! Please verify your options and try again.") | python | def cli(env, volume_id, new_size, new_iops, new_tier):
file_manager = SoftLayer.FileStorageManager(env.client)
if new_tier is not None:
new_tier = float(new_tier)
try:
order = file_manager.order_modified_volume(
volume_id,
new_size=new_size,
new_iops=new_iops,
new_tier_level=new_tier,
)
except ValueError as ex:
raise exceptions.ArgumentError(str(ex))
if 'placedOrder' in order.keys():
click.echo("Order
for item in order['placedOrder']['items']:
click.echo(" > %s" % item['description'])
else:
click.echo("Order could not be placed! Please verify your options and try again.") | [
"def",
"cli",
"(",
"env",
",",
"volume_id",
",",
"new_size",
",",
"new_iops",
",",
"new_tier",
")",
":",
"file_manager",
"=",
"SoftLayer",
".",
"FileStorageManager",
"(",
"env",
".",
"client",
")",
"if",
"new_tier",
"is",
"not",
"None",
":",
"new_tier",
"=",
"float",
"(",
"new_tier",
")",
"try",
":",
"order",
"=",
"file_manager",
".",
"order_modified_volume",
"(",
"volume_id",
",",
"new_size",
"=",
"new_size",
",",
"new_iops",
"=",
"new_iops",
",",
"new_tier_level",
"=",
"new_tier",
",",
")",
"except",
"ValueError",
"as",
"ex",
":",
"raise",
"exceptions",
".",
"ArgumentError",
"(",
"str",
"(",
"ex",
")",
")",
"if",
"'placedOrder'",
"in",
"order",
".",
"keys",
"(",
")",
":",
"click",
".",
"echo",
"(",
"\"Order #{0} placed successfully!\"",
".",
"format",
"(",
"order",
"[",
"'placedOrder'",
"]",
"[",
"'id'",
"]",
")",
")",
"for",
"item",
"in",
"order",
"[",
"'placedOrder'",
"]",
"[",
"'items'",
"]",
":",
"click",
".",
"echo",
"(",
"\" > %s\"",
"%",
"item",
"[",
"'description'",
"]",
")",
"else",
":",
"click",
".",
"echo",
"(",
"\"Order could not be placed! Please verify your options and try again.\"",
")"
]
| Modify an existing file storage volume. | [
"Modify",
"an",
"existing",
"file",
"storage",
"volume",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/CLI/file/modify.py#L35-L57 |
softlayer/softlayer-python | SoftLayer/managers/user.py | UserManager.list_users | def list_users(self, objectmask=None, objectfilter=None):
"""Lists all users on an account
:param string objectmask: Used to overwrite the default objectmask.
:param dictionary objectfilter: If you want to use an objectfilter.
:returns: A list of dictionaries that describe each user
Example::
result = mgr.list_users()
"""
if objectmask is None:
objectmask = """mask[id, username, displayName, userStatus[name], hardwareCount, virtualGuestCount,
email, roles]"""
return self.account_service.getUsers(mask=objectmask, filter=objectfilter) | python | def list_users(self, objectmask=None, objectfilter=None):
if objectmask is None:
objectmask =
return self.account_service.getUsers(mask=objectmask, filter=objectfilter) | [
"def",
"list_users",
"(",
"self",
",",
"objectmask",
"=",
"None",
",",
"objectfilter",
"=",
"None",
")",
":",
"if",
"objectmask",
"is",
"None",
":",
"objectmask",
"=",
"\"\"\"mask[id, username, displayName, userStatus[name], hardwareCount, virtualGuestCount,\n email, roles]\"\"\"",
"return",
"self",
".",
"account_service",
".",
"getUsers",
"(",
"mask",
"=",
"objectmask",
",",
"filter",
"=",
"objectfilter",
")"
]
| Lists all users on an account
:param string objectmask: Used to overwrite the default objectmask.
:param dictionary objectfilter: If you want to use an objectfilter.
:returns: A list of dictionaries that describe each user
Example::
result = mgr.list_users() | [
"Lists",
"all",
"users",
"on",
"an",
"account"
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/user.py#L41-L56 |
softlayer/softlayer-python | SoftLayer/managers/user.py | UserManager.get_user | def get_user(self, user_id, objectmask=None):
"""Calls SoftLayer_User_Customer::getObject
:param int user_id: Id of the user
:param string objectmask: default is 'mask[userStatus[name], parent[id, username]]'
:returns: A user object.
"""
if objectmask is None:
objectmask = "mask[userStatus[name], parent[id, username]]"
return self.user_service.getObject(id=user_id, mask=objectmask) | python | def get_user(self, user_id, objectmask=None):
if objectmask is None:
objectmask = "mask[userStatus[name], parent[id, username]]"
return self.user_service.getObject(id=user_id, mask=objectmask) | [
"def",
"get_user",
"(",
"self",
",",
"user_id",
",",
"objectmask",
"=",
"None",
")",
":",
"if",
"objectmask",
"is",
"None",
":",
"objectmask",
"=",
"\"mask[userStatus[name], parent[id, username]]\"",
"return",
"self",
".",
"user_service",
".",
"getObject",
"(",
"id",
"=",
"user_id",
",",
"mask",
"=",
"objectmask",
")"
]
| Calls SoftLayer_User_Customer::getObject
:param int user_id: Id of the user
:param string objectmask: default is 'mask[userStatus[name], parent[id, username]]'
:returns: A user object. | [
"Calls",
"SoftLayer_User_Customer",
"::",
"getObject"
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/user.py#L58-L67 |
softlayer/softlayer-python | SoftLayer/managers/user.py | UserManager.get_current_user | def get_current_user(self, objectmask=None):
"""Calls SoftLayer_Account::getCurrentUser"""
if objectmask is None:
objectmask = "mask[userStatus[name], parent[id, username]]"
return self.account_service.getCurrentUser(mask=objectmask) | python | def get_current_user(self, objectmask=None):
if objectmask is None:
objectmask = "mask[userStatus[name], parent[id, username]]"
return self.account_service.getCurrentUser(mask=objectmask) | [
"def",
"get_current_user",
"(",
"self",
",",
"objectmask",
"=",
"None",
")",
":",
"if",
"objectmask",
"is",
"None",
":",
"objectmask",
"=",
"\"mask[userStatus[name], parent[id, username]]\"",
"return",
"self",
".",
"account_service",
".",
"getCurrentUser",
"(",
"mask",
"=",
"objectmask",
")"
]
| Calls SoftLayer_Account::getCurrentUser | [
"Calls",
"SoftLayer_Account",
"::",
"getCurrentUser"
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/user.py#L69-L74 |
softlayer/softlayer-python | SoftLayer/managers/user.py | UserManager.get_all_permissions | def get_all_permissions(self):
"""Calls SoftLayer_User_CustomerPermissions_Permission::getAllObjects
Stores the result in self.all_permissions
:returns: A list of dictionaries that contains all valid permissions
"""
if self.all_permissions is None:
permissions = self.client.call('User_Customer_CustomerPermission_Permission', 'getAllObjects')
self.all_permissions = sorted(permissions, key=itemgetter('keyName'))
return self.all_permissions | python | def get_all_permissions(self):
if self.all_permissions is None:
permissions = self.client.call('User_Customer_CustomerPermission_Permission', 'getAllObjects')
self.all_permissions = sorted(permissions, key=itemgetter('keyName'))
return self.all_permissions | [
"def",
"get_all_permissions",
"(",
"self",
")",
":",
"if",
"self",
".",
"all_permissions",
"is",
"None",
":",
"permissions",
"=",
"self",
".",
"client",
".",
"call",
"(",
"'User_Customer_CustomerPermission_Permission'",
",",
"'getAllObjects'",
")",
"self",
".",
"all_permissions",
"=",
"sorted",
"(",
"permissions",
",",
"key",
"=",
"itemgetter",
"(",
"'keyName'",
")",
")",
"return",
"self",
".",
"all_permissions"
]
| Calls SoftLayer_User_CustomerPermissions_Permission::getAllObjects
Stores the result in self.all_permissions
:returns: A list of dictionaries that contains all valid permissions | [
"Calls",
"SoftLayer_User_CustomerPermissions_Permission",
"::",
"getAllObjects"
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/user.py#L76-L85 |
softlayer/softlayer-python | SoftLayer/managers/user.py | UserManager.add_permissions | def add_permissions(self, user_id, permissions):
"""Enables a list of permissions for a user
:param int id: user id to set
:param list permissions: List of permissions keynames to enable
:returns: True on success, Exception otherwise
Example::
add_permissions(123, ['BANDWIDTH_MANAGE'])
"""
pretty_permissions = self.format_permission_object(permissions)
LOGGER.warning("Adding the following permissions to %s: %s", user_id, pretty_permissions)
return self.user_service.addBulkPortalPermission(pretty_permissions, id=user_id) | python | def add_permissions(self, user_id, permissions):
pretty_permissions = self.format_permission_object(permissions)
LOGGER.warning("Adding the following permissions to %s: %s", user_id, pretty_permissions)
return self.user_service.addBulkPortalPermission(pretty_permissions, id=user_id) | [
"def",
"add_permissions",
"(",
"self",
",",
"user_id",
",",
"permissions",
")",
":",
"pretty_permissions",
"=",
"self",
".",
"format_permission_object",
"(",
"permissions",
")",
"LOGGER",
".",
"warning",
"(",
"\"Adding the following permissions to %s: %s\"",
",",
"user_id",
",",
"pretty_permissions",
")",
"return",
"self",
".",
"user_service",
".",
"addBulkPortalPermission",
"(",
"pretty_permissions",
",",
"id",
"=",
"user_id",
")"
]
| Enables a list of permissions for a user
:param int id: user id to set
:param list permissions: List of permissions keynames to enable
:returns: True on success, Exception otherwise
Example::
add_permissions(123, ['BANDWIDTH_MANAGE']) | [
"Enables",
"a",
"list",
"of",
"permissions",
"for",
"a",
"user"
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/user.py#L87-L99 |
softlayer/softlayer-python | SoftLayer/managers/user.py | UserManager.remove_permissions | def remove_permissions(self, user_id, permissions):
"""Disables a list of permissions for a user
:param int id: user id to set
:param list permissions: List of permissions keynames to disable
:returns: True on success, Exception otherwise
Example::
remove_permissions(123, ['BANDWIDTH_MANAGE'])
"""
pretty_permissions = self.format_permission_object(permissions)
LOGGER.warning("Removing the following permissions to %s: %s", user_id, pretty_permissions)
return self.user_service.removeBulkPortalPermission(pretty_permissions, id=user_id) | python | def remove_permissions(self, user_id, permissions):
pretty_permissions = self.format_permission_object(permissions)
LOGGER.warning("Removing the following permissions to %s: %s", user_id, pretty_permissions)
return self.user_service.removeBulkPortalPermission(pretty_permissions, id=user_id) | [
"def",
"remove_permissions",
"(",
"self",
",",
"user_id",
",",
"permissions",
")",
":",
"pretty_permissions",
"=",
"self",
".",
"format_permission_object",
"(",
"permissions",
")",
"LOGGER",
".",
"warning",
"(",
"\"Removing the following permissions to %s: %s\"",
",",
"user_id",
",",
"pretty_permissions",
")",
"return",
"self",
".",
"user_service",
".",
"removeBulkPortalPermission",
"(",
"pretty_permissions",
",",
"id",
"=",
"user_id",
")"
]
| Disables a list of permissions for a user
:param int id: user id to set
:param list permissions: List of permissions keynames to disable
:returns: True on success, Exception otherwise
Example::
remove_permissions(123, ['BANDWIDTH_MANAGE']) | [
"Disables",
"a",
"list",
"of",
"permissions",
"for",
"a",
"user"
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/user.py#L101-L113 |
softlayer/softlayer-python | SoftLayer/managers/user.py | UserManager.permissions_from_user | def permissions_from_user(self, user_id, from_user_id):
"""Sets user_id's permission to be the same as from_user_id's
Any permissions from_user_id has will be added to user_id.
Any permissions from_user_id doesn't have will be removed from user_id.
:param int user_id: The user to change permissions.
:param int from_user_id: The use to base permissions from.
:returns: True on success, Exception otherwise.
"""
from_permissions = self.get_user_permissions(from_user_id)
self.add_permissions(user_id, from_permissions)
all_permissions = self.get_all_permissions()
remove_permissions = []
for permission in all_permissions:
# If permission does not exist for from_user_id add it to the list to be removed
if _keyname_search(from_permissions, permission['keyName']):
continue
else:
remove_permissions.append({'keyName': permission['keyName']})
self.remove_permissions(user_id, remove_permissions)
return True | python | def permissions_from_user(self, user_id, from_user_id):
from_permissions = self.get_user_permissions(from_user_id)
self.add_permissions(user_id, from_permissions)
all_permissions = self.get_all_permissions()
remove_permissions = []
for permission in all_permissions:
if _keyname_search(from_permissions, permission['keyName']):
continue
else:
remove_permissions.append({'keyName': permission['keyName']})
self.remove_permissions(user_id, remove_permissions)
return True | [
"def",
"permissions_from_user",
"(",
"self",
",",
"user_id",
",",
"from_user_id",
")",
":",
"from_permissions",
"=",
"self",
".",
"get_user_permissions",
"(",
"from_user_id",
")",
"self",
".",
"add_permissions",
"(",
"user_id",
",",
"from_permissions",
")",
"all_permissions",
"=",
"self",
".",
"get_all_permissions",
"(",
")",
"remove_permissions",
"=",
"[",
"]",
"for",
"permission",
"in",
"all_permissions",
":",
"# If permission does not exist for from_user_id add it to the list to be removed",
"if",
"_keyname_search",
"(",
"from_permissions",
",",
"permission",
"[",
"'keyName'",
"]",
")",
":",
"continue",
"else",
":",
"remove_permissions",
".",
"append",
"(",
"{",
"'keyName'",
":",
"permission",
"[",
"'keyName'",
"]",
"}",
")",
"self",
".",
"remove_permissions",
"(",
"user_id",
",",
"remove_permissions",
")",
"return",
"True"
]
| Sets user_id's permission to be the same as from_user_id's
Any permissions from_user_id has will be added to user_id.
Any permissions from_user_id doesn't have will be removed from user_id.
:param int user_id: The user to change permissions.
:param int from_user_id: The use to base permissions from.
:returns: True on success, Exception otherwise. | [
"Sets",
"user_id",
"s",
"permission",
"to",
"be",
"the",
"same",
"as",
"from_user_id",
"s"
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/user.py#L115-L139 |
softlayer/softlayer-python | SoftLayer/managers/user.py | UserManager.get_user_permissions | def get_user_permissions(self, user_id):
"""Returns a sorted list of a users permissions"""
permissions = self.user_service.getPermissions(id=user_id)
return sorted(permissions, key=itemgetter('keyName')) | python | def get_user_permissions(self, user_id):
permissions = self.user_service.getPermissions(id=user_id)
return sorted(permissions, key=itemgetter('keyName')) | [
"def",
"get_user_permissions",
"(",
"self",
",",
"user_id",
")",
":",
"permissions",
"=",
"self",
".",
"user_service",
".",
"getPermissions",
"(",
"id",
"=",
"user_id",
")",
"return",
"sorted",
"(",
"permissions",
",",
"key",
"=",
"itemgetter",
"(",
"'keyName'",
")",
")"
]
| Returns a sorted list of a users permissions | [
"Returns",
"a",
"sorted",
"list",
"of",
"a",
"users",
"permissions"
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/user.py#L141-L144 |
softlayer/softlayer-python | SoftLayer/managers/user.py | UserManager.get_logins | def get_logins(self, user_id, start_date=None):
"""Gets the login history for a user, default start_date is 30 days ago
:param int id: User id to get
:param string start_date: "%m/%d/%Y %H:%M:%s" formatted string.
:returns: list https://softlayer.github.io/reference/datatypes/SoftLayer_User_Customer_Access_Authentication/
Example::
get_logins(123, '04/08/2018 0:0:0')
"""
if start_date is None:
date_object = datetime.datetime.today() - datetime.timedelta(days=30)
start_date = date_object.strftime("%m/%d/%Y 0:0:0")
date_filter = {
'loginAttempts': {
'createDate': {
'operation': 'greaterThanDate',
'options': [{'name': 'date', 'value': [start_date]}]
}
}
}
login_log = self.user_service.getLoginAttempts(id=user_id, filter=date_filter)
return login_log | python | def get_logins(self, user_id, start_date=None):
if start_date is None:
date_object = datetime.datetime.today() - datetime.timedelta(days=30)
start_date = date_object.strftime("%m/%d/%Y 0:0:0")
date_filter = {
'loginAttempts': {
'createDate': {
'operation': 'greaterThanDate',
'options': [{'name': 'date', 'value': [start_date]}]
}
}
}
login_log = self.user_service.getLoginAttempts(id=user_id, filter=date_filter)
return login_log | [
"def",
"get_logins",
"(",
"self",
",",
"user_id",
",",
"start_date",
"=",
"None",
")",
":",
"if",
"start_date",
"is",
"None",
":",
"date_object",
"=",
"datetime",
".",
"datetime",
".",
"today",
"(",
")",
"-",
"datetime",
".",
"timedelta",
"(",
"days",
"=",
"30",
")",
"start_date",
"=",
"date_object",
".",
"strftime",
"(",
"\"%m/%d/%Y 0:0:0\"",
")",
"date_filter",
"=",
"{",
"'loginAttempts'",
":",
"{",
"'createDate'",
":",
"{",
"'operation'",
":",
"'greaterThanDate'",
",",
"'options'",
":",
"[",
"{",
"'name'",
":",
"'date'",
",",
"'value'",
":",
"[",
"start_date",
"]",
"}",
"]",
"}",
"}",
"}",
"login_log",
"=",
"self",
".",
"user_service",
".",
"getLoginAttempts",
"(",
"id",
"=",
"user_id",
",",
"filter",
"=",
"date_filter",
")",
"return",
"login_log"
]
| Gets the login history for a user, default start_date is 30 days ago
:param int id: User id to get
:param string start_date: "%m/%d/%Y %H:%M:%s" formatted string.
:returns: list https://softlayer.github.io/reference/datatypes/SoftLayer_User_Customer_Access_Authentication/
Example::
get_logins(123, '04/08/2018 0:0:0') | [
"Gets",
"the",
"login",
"history",
"for",
"a",
"user",
"default",
"start_date",
"is",
"30",
"days",
"ago"
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/user.py#L146-L169 |
softlayer/softlayer-python | SoftLayer/managers/user.py | UserManager.get_events | def get_events(self, user_id, start_date=None):
"""Gets the event log for a specific user, default start_date is 30 days ago
:param int id: User id to view
:param string start_date: "%Y-%m-%dT%H:%M:%s.0000-06:00" is the full formatted string.
The Timezone part has to be HH:MM, notice the : there.
:returns: https://softlayer.github.io/reference/datatypes/SoftLayer_Event_Log/
"""
if start_date is None:
date_object = datetime.datetime.today() - datetime.timedelta(days=30)
start_date = date_object.strftime("%Y-%m-%dT00:00:00")
object_filter = {
'userId': {
'operation': user_id
},
'eventCreateDate': {
'operation': 'greaterThanDate',
'options': [{'name': 'date', 'value': [start_date]}]
}
}
events = self.client.call('Event_Log', 'getAllObjects', filter=object_filter)
if events is None:
events = [{'eventName': 'No Events Found'}]
return events | python | def get_events(self, user_id, start_date=None):
if start_date is None:
date_object = datetime.datetime.today() - datetime.timedelta(days=30)
start_date = date_object.strftime("%Y-%m-%dT00:00:00")
object_filter = {
'userId': {
'operation': user_id
},
'eventCreateDate': {
'operation': 'greaterThanDate',
'options': [{'name': 'date', 'value': [start_date]}]
}
}
events = self.client.call('Event_Log', 'getAllObjects', filter=object_filter)
if events is None:
events = [{'eventName': 'No Events Found'}]
return events | [
"def",
"get_events",
"(",
"self",
",",
"user_id",
",",
"start_date",
"=",
"None",
")",
":",
"if",
"start_date",
"is",
"None",
":",
"date_object",
"=",
"datetime",
".",
"datetime",
".",
"today",
"(",
")",
"-",
"datetime",
".",
"timedelta",
"(",
"days",
"=",
"30",
")",
"start_date",
"=",
"date_object",
".",
"strftime",
"(",
"\"%Y-%m-%dT00:00:00\"",
")",
"object_filter",
"=",
"{",
"'userId'",
":",
"{",
"'operation'",
":",
"user_id",
"}",
",",
"'eventCreateDate'",
":",
"{",
"'operation'",
":",
"'greaterThanDate'",
",",
"'options'",
":",
"[",
"{",
"'name'",
":",
"'date'",
",",
"'value'",
":",
"[",
"start_date",
"]",
"}",
"]",
"}",
"}",
"events",
"=",
"self",
".",
"client",
".",
"call",
"(",
"'Event_Log'",
",",
"'getAllObjects'",
",",
"filter",
"=",
"object_filter",
")",
"if",
"events",
"is",
"None",
":",
"events",
"=",
"[",
"{",
"'eventName'",
":",
"'No Events Found'",
"}",
"]",
"return",
"events"
]
| Gets the event log for a specific user, default start_date is 30 days ago
:param int id: User id to view
:param string start_date: "%Y-%m-%dT%H:%M:%s.0000-06:00" is the full formatted string.
The Timezone part has to be HH:MM, notice the : there.
:returns: https://softlayer.github.io/reference/datatypes/SoftLayer_Event_Log/ | [
"Gets",
"the",
"event",
"log",
"for",
"a",
"specific",
"user",
"default",
"start_date",
"is",
"30",
"days",
"ago"
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/user.py#L171-L197 |
softlayer/softlayer-python | SoftLayer/managers/user.py | UserManager._get_id_from_username | def _get_id_from_username(self, username):
"""Looks up a username's id
:param string username: Username to lookup
:returns: The id that matches username.
"""
_mask = "mask[id, username]"
_filter = {'users': {'username': utils.query_filter(username)}}
user = self.list_users(_mask, _filter)
if len(user) == 1:
return [user[0]['id']]
elif len(user) > 1:
raise exceptions.SoftLayerError("Multiple users found with the name: %s" % username)
else:
raise exceptions.SoftLayerError("Unable to find user id for %s" % username) | python | def _get_id_from_username(self, username):
_mask = "mask[id, username]"
_filter = {'users': {'username': utils.query_filter(username)}}
user = self.list_users(_mask, _filter)
if len(user) == 1:
return [user[0]['id']]
elif len(user) > 1:
raise exceptions.SoftLayerError("Multiple users found with the name: %s" % username)
else:
raise exceptions.SoftLayerError("Unable to find user id for %s" % username) | [
"def",
"_get_id_from_username",
"(",
"self",
",",
"username",
")",
":",
"_mask",
"=",
"\"mask[id, username]\"",
"_filter",
"=",
"{",
"'users'",
":",
"{",
"'username'",
":",
"utils",
".",
"query_filter",
"(",
"username",
")",
"}",
"}",
"user",
"=",
"self",
".",
"list_users",
"(",
"_mask",
",",
"_filter",
")",
"if",
"len",
"(",
"user",
")",
"==",
"1",
":",
"return",
"[",
"user",
"[",
"0",
"]",
"[",
"'id'",
"]",
"]",
"elif",
"len",
"(",
"user",
")",
">",
"1",
":",
"raise",
"exceptions",
".",
"SoftLayerError",
"(",
"\"Multiple users found with the name: %s\"",
"%",
"username",
")",
"else",
":",
"raise",
"exceptions",
".",
"SoftLayerError",
"(",
"\"Unable to find user id for %s\"",
"%",
"username",
")"
]
| Looks up a username's id
:param string username: Username to lookup
:returns: The id that matches username. | [
"Looks",
"up",
"a",
"username",
"s",
"id"
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/user.py#L199-L213 |
softlayer/softlayer-python | SoftLayer/managers/user.py | UserManager.format_permission_object | def format_permission_object(self, permissions):
"""Formats a list of permission key names into something the SLAPI will respect.
:param list permissions: A list of SLAPI permissions keyNames.
keyName of ALL will return all permissions.
:returns: list of dictionaries that can be sent to the api to add or remove permissions
:throws SoftLayerError: If any permission is invalid this exception will be thrown.
"""
pretty_permissions = []
available_permissions = self.get_all_permissions()
# pp(available_permissions)
for permission in permissions:
# Handle data retrieved directly from the API
if isinstance(permission, dict):
permission = permission['keyName']
permission = permission.upper()
if permission == 'ALL':
return available_permissions
# Search through available_permissions to make sure what the user entered was valid
if _keyname_search(available_permissions, permission):
pretty_permissions.append({'keyName': permission})
else:
raise exceptions.SoftLayerError("'%s' is not a valid permission" % permission)
return pretty_permissions | python | def format_permission_object(self, permissions):
pretty_permissions = []
available_permissions = self.get_all_permissions()
for permission in permissions:
if isinstance(permission, dict):
permission = permission['keyName']
permission = permission.upper()
if permission == 'ALL':
return available_permissions
if _keyname_search(available_permissions, permission):
pretty_permissions.append({'keyName': permission})
else:
raise exceptions.SoftLayerError("'%s' is not a valid permission" % permission)
return pretty_permissions | [
"def",
"format_permission_object",
"(",
"self",
",",
"permissions",
")",
":",
"pretty_permissions",
"=",
"[",
"]",
"available_permissions",
"=",
"self",
".",
"get_all_permissions",
"(",
")",
"# pp(available_permissions)",
"for",
"permission",
"in",
"permissions",
":",
"# Handle data retrieved directly from the API",
"if",
"isinstance",
"(",
"permission",
",",
"dict",
")",
":",
"permission",
"=",
"permission",
"[",
"'keyName'",
"]",
"permission",
"=",
"permission",
".",
"upper",
"(",
")",
"if",
"permission",
"==",
"'ALL'",
":",
"return",
"available_permissions",
"# Search through available_permissions to make sure what the user entered was valid",
"if",
"_keyname_search",
"(",
"available_permissions",
",",
"permission",
")",
":",
"pretty_permissions",
".",
"append",
"(",
"{",
"'keyName'",
":",
"permission",
"}",
")",
"else",
":",
"raise",
"exceptions",
".",
"SoftLayerError",
"(",
"\"'%s' is not a valid permission\"",
"%",
"permission",
")",
"return",
"pretty_permissions"
]
| Formats a list of permission key names into something the SLAPI will respect.
:param list permissions: A list of SLAPI permissions keyNames.
keyName of ALL will return all permissions.
:returns: list of dictionaries that can be sent to the api to add or remove permissions
:throws SoftLayerError: If any permission is invalid this exception will be thrown. | [
"Formats",
"a",
"list",
"of",
"permission",
"key",
"names",
"into",
"something",
"the",
"SLAPI",
"will",
"respect",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/user.py#L215-L238 |
softlayer/softlayer-python | SoftLayer/managers/user.py | UserManager.create_user | def create_user(self, user_object, password):
"""Blindly sends user_object to SoftLayer_User_Customer::createObject
:param dictionary user_object: https://softlayer.github.io/reference/datatypes/SoftLayer_User_Customer/
"""
LOGGER.warning("Creating User %s", user_object['username'])
try:
return self.user_service.createObject(user_object, password, None)
except exceptions.SoftLayerAPIError as ex:
if ex.faultCode == "SoftLayer_Exception_User_Customer_DelegateIamIdInvitationToPaas":
raise exceptions.SoftLayerError("Your request for a new user was received, but it needs to be "
"processed by the Platform Services API first. Barring any errors on "
"the Platform Services side, your new user should be created shortly.")
raise | python | def create_user(self, user_object, password):
LOGGER.warning("Creating User %s", user_object['username'])
try:
return self.user_service.createObject(user_object, password, None)
except exceptions.SoftLayerAPIError as ex:
if ex.faultCode == "SoftLayer_Exception_User_Customer_DelegateIamIdInvitationToPaas":
raise exceptions.SoftLayerError("Your request for a new user was received, but it needs to be "
"processed by the Platform Services API first. Barring any errors on "
"the Platform Services side, your new user should be created shortly.")
raise | [
"def",
"create_user",
"(",
"self",
",",
"user_object",
",",
"password",
")",
":",
"LOGGER",
".",
"warning",
"(",
"\"Creating User %s\"",
",",
"user_object",
"[",
"'username'",
"]",
")",
"try",
":",
"return",
"self",
".",
"user_service",
".",
"createObject",
"(",
"user_object",
",",
"password",
",",
"None",
")",
"except",
"exceptions",
".",
"SoftLayerAPIError",
"as",
"ex",
":",
"if",
"ex",
".",
"faultCode",
"==",
"\"SoftLayer_Exception_User_Customer_DelegateIamIdInvitationToPaas\"",
":",
"raise",
"exceptions",
".",
"SoftLayerError",
"(",
"\"Your request for a new user was received, but it needs to be \"",
"\"processed by the Platform Services API first. Barring any errors on \"",
"\"the Platform Services side, your new user should be created shortly.\"",
")",
"raise"
]
| Blindly sends user_object to SoftLayer_User_Customer::createObject
:param dictionary user_object: https://softlayer.github.io/reference/datatypes/SoftLayer_User_Customer/ | [
"Blindly",
"sends",
"user_object",
"to",
"SoftLayer_User_Customer",
"::",
"createObject"
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/user.py#L240-L254 |
softlayer/softlayer-python | SoftLayer/managers/user.py | UserManager.edit_user | def edit_user(self, user_id, user_object):
"""Blindly sends user_object to SoftLayer_User_Customer::editObject
:param int user_id: User to edit
:param dictionary user_object: https://softlayer.github.io/reference/datatypes/SoftLayer_User_Customer/
"""
return self.user_service.editObject(user_object, id=user_id) | python | def edit_user(self, user_id, user_object):
return self.user_service.editObject(user_object, id=user_id) | [
"def",
"edit_user",
"(",
"self",
",",
"user_id",
",",
"user_object",
")",
":",
"return",
"self",
".",
"user_service",
".",
"editObject",
"(",
"user_object",
",",
"id",
"=",
"user_id",
")"
]
| Blindly sends user_object to SoftLayer_User_Customer::editObject
:param int user_id: User to edit
:param dictionary user_object: https://softlayer.github.io/reference/datatypes/SoftLayer_User_Customer/ | [
"Blindly",
"sends",
"user_object",
"to",
"SoftLayer_User_Customer",
"::",
"editObject"
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/user.py#L256-L262 |
softlayer/softlayer-python | SoftLayer/CLI/globalip/unassign.py | cli | def cli(env, identifier):
"""Unassigns a global IP from a target."""
mgr = SoftLayer.NetworkManager(env.client)
global_ip_id = helpers.resolve_id(mgr.resolve_global_ip_ids, identifier,
name='global ip')
mgr.unassign_global_ip(global_ip_id) | python | def cli(env, identifier):
mgr = SoftLayer.NetworkManager(env.client)
global_ip_id = helpers.resolve_id(mgr.resolve_global_ip_ids, identifier,
name='global ip')
mgr.unassign_global_ip(global_ip_id) | [
"def",
"cli",
"(",
"env",
",",
"identifier",
")",
":",
"mgr",
"=",
"SoftLayer",
".",
"NetworkManager",
"(",
"env",
".",
"client",
")",
"global_ip_id",
"=",
"helpers",
".",
"resolve_id",
"(",
"mgr",
".",
"resolve_global_ip_ids",
",",
"identifier",
",",
"name",
"=",
"'global ip'",
")",
"mgr",
".",
"unassign_global_ip",
"(",
"global_ip_id",
")"
]
| Unassigns a global IP from a target. | [
"Unassigns",
"a",
"global",
"IP",
"from",
"a",
"target",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/CLI/globalip/unassign.py#L14-L20 |
softlayer/softlayer-python | SoftLayer/CLI/vpn/ipsec/configure.py | cli | def cli(env, context_id):
"""Request configuration of a tunnel context.
This action will update the advancedConfigurationFlag on the context
instance and further modifications against the context will be prevented
until all changes can be propgated to network devices.
"""
manager = SoftLayer.IPSECManager(env.client)
# ensure context can be retrieved by given id
manager.get_tunnel_context(context_id)
succeeded = manager.apply_configuration(context_id)
if succeeded:
env.out('Configuration request received for context #{}'
.format(context_id))
else:
raise CLIHalt('Failed to enqueue configuration request for context #{}'
.format(context_id)) | python | def cli(env, context_id):
manager = SoftLayer.IPSECManager(env.client)
manager.get_tunnel_context(context_id)
succeeded = manager.apply_configuration(context_id)
if succeeded:
env.out('Configuration request received for context
.format(context_id))
else:
raise CLIHalt('Failed to enqueue configuration request for context
.format(context_id)) | [
"def",
"cli",
"(",
"env",
",",
"context_id",
")",
":",
"manager",
"=",
"SoftLayer",
".",
"IPSECManager",
"(",
"env",
".",
"client",
")",
"# ensure context can be retrieved by given id",
"manager",
".",
"get_tunnel_context",
"(",
"context_id",
")",
"succeeded",
"=",
"manager",
".",
"apply_configuration",
"(",
"context_id",
")",
"if",
"succeeded",
":",
"env",
".",
"out",
"(",
"'Configuration request received for context #{}'",
".",
"format",
"(",
"context_id",
")",
")",
"else",
":",
"raise",
"CLIHalt",
"(",
"'Failed to enqueue configuration request for context #{}'",
".",
"format",
"(",
"context_id",
")",
")"
]
| Request configuration of a tunnel context.
This action will update the advancedConfigurationFlag on the context
instance and further modifications against the context will be prevented
until all changes can be propgated to network devices. | [
"Request",
"configuration",
"of",
"a",
"tunnel",
"context",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/CLI/vpn/ipsec/configure.py#L14-L31 |
softlayer/softlayer-python | SoftLayer/managers/dns.py | DNSManager._get_zone_id_from_name | def _get_zone_id_from_name(self, name):
"""Return zone ID based on a zone."""
results = self.client['Account'].getDomains(
filter={"domains": {"name": utils.query_filter(name)}})
return [x['id'] for x in results] | python | def _get_zone_id_from_name(self, name):
results = self.client['Account'].getDomains(
filter={"domains": {"name": utils.query_filter(name)}})
return [x['id'] for x in results] | [
"def",
"_get_zone_id_from_name",
"(",
"self",
",",
"name",
")",
":",
"results",
"=",
"self",
".",
"client",
"[",
"'Account'",
"]",
".",
"getDomains",
"(",
"filter",
"=",
"{",
"\"domains\"",
":",
"{",
"\"name\"",
":",
"utils",
".",
"query_filter",
"(",
"name",
")",
"}",
"}",
")",
"return",
"[",
"x",
"[",
"'id'",
"]",
"for",
"x",
"in",
"results",
"]"
]
| Return zone ID based on a zone. | [
"Return",
"zone",
"ID",
"based",
"on",
"a",
"zone",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/dns.py#L28-L32 |
softlayer/softlayer-python | SoftLayer/managers/dns.py | DNSManager.get_zone | def get_zone(self, zone_id, records=True):
"""Get a zone and its records.
:param zone: the zone name
:returns: A dictionary containing a large amount of information about
the specified zone.
"""
mask = None
if records:
mask = 'resourceRecords'
return self.service.getObject(id=zone_id, mask=mask) | python | def get_zone(self, zone_id, records=True):
mask = None
if records:
mask = 'resourceRecords'
return self.service.getObject(id=zone_id, mask=mask) | [
"def",
"get_zone",
"(",
"self",
",",
"zone_id",
",",
"records",
"=",
"True",
")",
":",
"mask",
"=",
"None",
"if",
"records",
":",
"mask",
"=",
"'resourceRecords'",
"return",
"self",
".",
"service",
".",
"getObject",
"(",
"id",
"=",
"zone_id",
",",
"mask",
"=",
"mask",
")"
]
| Get a zone and its records.
:param zone: the zone name
:returns: A dictionary containing a large amount of information about
the specified zone. | [
"Get",
"a",
"zone",
"and",
"its",
"records",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/dns.py#L43-L54 |
softlayer/softlayer-python | SoftLayer/managers/dns.py | DNSManager.create_zone | def create_zone(self, zone, serial=None):
"""Create a zone for the specified zone.
:param zone: the zone name to create
:param serial: serial value on the zone (default: strftime(%Y%m%d01))
"""
return self.service.createObject({
'name': zone,
'serial': serial or time.strftime('%Y%m%d01'),
"resourceRecords": {}}) | python | def create_zone(self, zone, serial=None):
return self.service.createObject({
'name': zone,
'serial': serial or time.strftime('%Y%m%d01'),
"resourceRecords": {}}) | [
"def",
"create_zone",
"(",
"self",
",",
"zone",
",",
"serial",
"=",
"None",
")",
":",
"return",
"self",
".",
"service",
".",
"createObject",
"(",
"{",
"'name'",
":",
"zone",
",",
"'serial'",
":",
"serial",
"or",
"time",
".",
"strftime",
"(",
"'%Y%m%d01'",
")",
",",
"\"resourceRecords\"",
":",
"{",
"}",
"}",
")"
]
| Create a zone for the specified zone.
:param zone: the zone name to create
:param serial: serial value on the zone (default: strftime(%Y%m%d01)) | [
"Create",
"a",
"zone",
"for",
"the",
"specified",
"zone",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/dns.py#L56-L66 |
softlayer/softlayer-python | SoftLayer/managers/dns.py | DNSManager.create_record | def create_record(self, zone_id, record, record_type, data, ttl=60):
"""Create a resource record on a domain.
:param integer id: the zone's ID
:param record: the name of the record to add
:param record_type: the type of record (A, AAAA, CNAME, TXT, etc.)
:param data: the record's value
:param integer ttl: the TTL or time-to-live value (default: 60)
"""
resource_record = self._generate_create_dict(record, record_type, data,
ttl, domainId=zone_id)
return self.record.createObject(resource_record) | python | def create_record(self, zone_id, record, record_type, data, ttl=60):
resource_record = self._generate_create_dict(record, record_type, data,
ttl, domainId=zone_id)
return self.record.createObject(resource_record) | [
"def",
"create_record",
"(",
"self",
",",
"zone_id",
",",
"record",
",",
"record_type",
",",
"data",
",",
"ttl",
"=",
"60",
")",
":",
"resource_record",
"=",
"self",
".",
"_generate_create_dict",
"(",
"record",
",",
"record_type",
",",
"data",
",",
"ttl",
",",
"domainId",
"=",
"zone_id",
")",
"return",
"self",
".",
"record",
".",
"createObject",
"(",
"resource_record",
")"
]
| Create a resource record on a domain.
:param integer id: the zone's ID
:param record: the name of the record to add
:param record_type: the type of record (A, AAAA, CNAME, TXT, etc.)
:param data: the record's value
:param integer ttl: the TTL or time-to-live value (default: 60) | [
"Create",
"a",
"resource",
"record",
"on",
"a",
"domain",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/dns.py#L87-L99 |
softlayer/softlayer-python | SoftLayer/managers/dns.py | DNSManager.create_record_mx | def create_record_mx(self, zone_id, record, data, ttl=60, priority=10):
"""Create a mx resource record on a domain.
:param integer id: the zone's ID
:param record: the name of the record to add
:param data: the record's value
:param integer ttl: the TTL or time-to-live value (default: 60)
:param integer priority: the priority of the target host
"""
resource_record = self._generate_create_dict(record, 'MX', data, ttl,
domainId=zone_id, mxPriority=priority)
return self.record.createObject(resource_record) | python | def create_record_mx(self, zone_id, record, data, ttl=60, priority=10):
resource_record = self._generate_create_dict(record, 'MX', data, ttl,
domainId=zone_id, mxPriority=priority)
return self.record.createObject(resource_record) | [
"def",
"create_record_mx",
"(",
"self",
",",
"zone_id",
",",
"record",
",",
"data",
",",
"ttl",
"=",
"60",
",",
"priority",
"=",
"10",
")",
":",
"resource_record",
"=",
"self",
".",
"_generate_create_dict",
"(",
"record",
",",
"'MX'",
",",
"data",
",",
"ttl",
",",
"domainId",
"=",
"zone_id",
",",
"mxPriority",
"=",
"priority",
")",
"return",
"self",
".",
"record",
".",
"createObject",
"(",
"resource_record",
")"
]
| Create a mx resource record on a domain.
:param integer id: the zone's ID
:param record: the name of the record to add
:param data: the record's value
:param integer ttl: the TTL or time-to-live value (default: 60)
:param integer priority: the priority of the target host | [
"Create",
"a",
"mx",
"resource",
"record",
"on",
"a",
"domain",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/dns.py#L101-L113 |
softlayer/softlayer-python | SoftLayer/managers/dns.py | DNSManager.create_record_srv | def create_record_srv(self, zone_id, record, data, protocol, port, service,
ttl=60, priority=20, weight=10):
"""Create a resource record on a domain.
:param integer id: the zone's ID
:param record: the name of the record to add
:param data: the record's value
:param string protocol: the protocol of the service, usually either TCP or UDP.
:param integer port: the TCP or UDP port on which the service is to be found.
:param string service: the symbolic name of the desired service.
:param integer ttl: the TTL or time-to-live value (default: 60)
:param integer priority: the priority of the target host (default: 20)
:param integer weight: relative weight for records with same priority (default: 10)
"""
resource_record = self._generate_create_dict(record, 'SRV', data, ttl, domainId=zone_id,
priority=priority, protocol=protocol, port=port,
service=service, weight=weight)
# The createObject won't creates SRV records unless we send the following complexType.
resource_record['complexType'] = 'SoftLayer_Dns_Domain_ResourceRecord_SrvType'
return self.record.createObject(resource_record) | python | def create_record_srv(self, zone_id, record, data, protocol, port, service,
ttl=60, priority=20, weight=10):
resource_record = self._generate_create_dict(record, 'SRV', data, ttl, domainId=zone_id,
priority=priority, protocol=protocol, port=port,
service=service, weight=weight)
resource_record['complexType'] = 'SoftLayer_Dns_Domain_ResourceRecord_SrvType'
return self.record.createObject(resource_record) | [
"def",
"create_record_srv",
"(",
"self",
",",
"zone_id",
",",
"record",
",",
"data",
",",
"protocol",
",",
"port",
",",
"service",
",",
"ttl",
"=",
"60",
",",
"priority",
"=",
"20",
",",
"weight",
"=",
"10",
")",
":",
"resource_record",
"=",
"self",
".",
"_generate_create_dict",
"(",
"record",
",",
"'SRV'",
",",
"data",
",",
"ttl",
",",
"domainId",
"=",
"zone_id",
",",
"priority",
"=",
"priority",
",",
"protocol",
"=",
"protocol",
",",
"port",
"=",
"port",
",",
"service",
"=",
"service",
",",
"weight",
"=",
"weight",
")",
"# The createObject won't creates SRV records unless we send the following complexType.",
"resource_record",
"[",
"'complexType'",
"]",
"=",
"'SoftLayer_Dns_Domain_ResourceRecord_SrvType'",
"return",
"self",
".",
"record",
".",
"createObject",
"(",
"resource_record",
")"
]
| Create a resource record on a domain.
:param integer id: the zone's ID
:param record: the name of the record to add
:param data: the record's value
:param string protocol: the protocol of the service, usually either TCP or UDP.
:param integer port: the TCP or UDP port on which the service is to be found.
:param string service: the symbolic name of the desired service.
:param integer ttl: the TTL or time-to-live value (default: 60)
:param integer priority: the priority of the target host (default: 20)
:param integer weight: relative weight for records with same priority (default: 10) | [
"Create",
"a",
"resource",
"record",
"on",
"a",
"domain",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/dns.py#L115-L137 |
softlayer/softlayer-python | SoftLayer/managers/dns.py | DNSManager.create_record_ptr | def create_record_ptr(self, record, data, ttl=60):
"""Create a reverse record.
:param record: the public ip address of device for which you would like to manage reverse DNS.
:param data: the record's value
:param integer ttl: the TTL or time-to-live value (default: 60)
"""
resource_record = self._generate_create_dict(record, 'PTR', data, ttl)
return self.record.createObject(resource_record) | python | def create_record_ptr(self, record, data, ttl=60):
resource_record = self._generate_create_dict(record, 'PTR', data, ttl)
return self.record.createObject(resource_record) | [
"def",
"create_record_ptr",
"(",
"self",
",",
"record",
",",
"data",
",",
"ttl",
"=",
"60",
")",
":",
"resource_record",
"=",
"self",
".",
"_generate_create_dict",
"(",
"record",
",",
"'PTR'",
",",
"data",
",",
"ttl",
")",
"return",
"self",
".",
"record",
".",
"createObject",
"(",
"resource_record",
")"
]
| Create a reverse record.
:param record: the public ip address of device for which you would like to manage reverse DNS.
:param data: the record's value
:param integer ttl: the TTL or time-to-live value (default: 60) | [
"Create",
"a",
"reverse",
"record",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/dns.py#L139-L149 |
softlayer/softlayer-python | SoftLayer/managers/dns.py | DNSManager._generate_create_dict | def _generate_create_dict(record, record_type, data, ttl, **kwargs):
"""Returns a dict appropriate to pass into Dns_Domain_ResourceRecord::createObject"""
# Basic dns record structure
resource_record = {
'host': record,
'data': data,
'ttl': ttl,
'type': record_type
}
for (key, value) in kwargs.items():
resource_record.setdefault(key, value)
return resource_record | python | def _generate_create_dict(record, record_type, data, ttl, **kwargs):
resource_record = {
'host': record,
'data': data,
'ttl': ttl,
'type': record_type
}
for (key, value) in kwargs.items():
resource_record.setdefault(key, value)
return resource_record | [
"def",
"_generate_create_dict",
"(",
"record",
",",
"record_type",
",",
"data",
",",
"ttl",
",",
"*",
"*",
"kwargs",
")",
":",
"# Basic dns record structure",
"resource_record",
"=",
"{",
"'host'",
":",
"record",
",",
"'data'",
":",
"data",
",",
"'ttl'",
":",
"ttl",
",",
"'type'",
":",
"record_type",
"}",
"for",
"(",
"key",
",",
"value",
")",
"in",
"kwargs",
".",
"items",
"(",
")",
":",
"resource_record",
".",
"setdefault",
"(",
"key",
",",
"value",
")",
"return",
"resource_record"
]
| Returns a dict appropriate to pass into Dns_Domain_ResourceRecord::createObject | [
"Returns",
"a",
"dict",
"appropriate",
"to",
"pass",
"into",
"Dns_Domain_ResourceRecord",
"::",
"createObject"
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/dns.py#L152-L166 |
softlayer/softlayer-python | SoftLayer/managers/dns.py | DNSManager.get_records | def get_records(self, zone_id, ttl=None, data=None, host=None,
record_type=None):
"""List, and optionally filter, records within a zone.
:param zone: the zone name in which to search.
:param int ttl: time in seconds
:param str data: the records data
:param str host: record's host
:param str record_type: the type of record
:returns: A list of dictionaries representing the matching records
within the specified zone.
"""
_filter = utils.NestedDict()
if ttl:
_filter['resourceRecords']['ttl'] = utils.query_filter(ttl)
if host:
_filter['resourceRecords']['host'] = utils.query_filter(host)
if data:
_filter['resourceRecords']['data'] = utils.query_filter(data)
if record_type:
_filter['resourceRecords']['type'] = utils.query_filter(
record_type.lower())
results = self.service.getResourceRecords(
id=zone_id,
mask='id,expire,domainId,host,minimum,refresh,retry,'
'mxPriority,ttl,type,data,responsiblePerson',
filter=_filter.to_dict(),
)
return results | python | def get_records(self, zone_id, ttl=None, data=None, host=None,
record_type=None):
_filter = utils.NestedDict()
if ttl:
_filter['resourceRecords']['ttl'] = utils.query_filter(ttl)
if host:
_filter['resourceRecords']['host'] = utils.query_filter(host)
if data:
_filter['resourceRecords']['data'] = utils.query_filter(data)
if record_type:
_filter['resourceRecords']['type'] = utils.query_filter(
record_type.lower())
results = self.service.getResourceRecords(
id=zone_id,
mask='id,expire,domainId,host,minimum,refresh,retry,'
'mxPriority,ttl,type,data,responsiblePerson',
filter=_filter.to_dict(),
)
return results | [
"def",
"get_records",
"(",
"self",
",",
"zone_id",
",",
"ttl",
"=",
"None",
",",
"data",
"=",
"None",
",",
"host",
"=",
"None",
",",
"record_type",
"=",
"None",
")",
":",
"_filter",
"=",
"utils",
".",
"NestedDict",
"(",
")",
"if",
"ttl",
":",
"_filter",
"[",
"'resourceRecords'",
"]",
"[",
"'ttl'",
"]",
"=",
"utils",
".",
"query_filter",
"(",
"ttl",
")",
"if",
"host",
":",
"_filter",
"[",
"'resourceRecords'",
"]",
"[",
"'host'",
"]",
"=",
"utils",
".",
"query_filter",
"(",
"host",
")",
"if",
"data",
":",
"_filter",
"[",
"'resourceRecords'",
"]",
"[",
"'data'",
"]",
"=",
"utils",
".",
"query_filter",
"(",
"data",
")",
"if",
"record_type",
":",
"_filter",
"[",
"'resourceRecords'",
"]",
"[",
"'type'",
"]",
"=",
"utils",
".",
"query_filter",
"(",
"record_type",
".",
"lower",
"(",
")",
")",
"results",
"=",
"self",
".",
"service",
".",
"getResourceRecords",
"(",
"id",
"=",
"zone_id",
",",
"mask",
"=",
"'id,expire,domainId,host,minimum,refresh,retry,'",
"'mxPriority,ttl,type,data,responsiblePerson'",
",",
"filter",
"=",
"_filter",
".",
"to_dict",
"(",
")",
",",
")",
"return",
"results"
]
| List, and optionally filter, records within a zone.
:param zone: the zone name in which to search.
:param int ttl: time in seconds
:param str data: the records data
:param str host: record's host
:param str record_type: the type of record
:returns: A list of dictionaries representing the matching records
within the specified zone. | [
"List",
"and",
"optionally",
"filter",
"records",
"within",
"a",
"zone",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/dns.py#L183-L218 |
softlayer/softlayer-python | SoftLayer/managers/dedicated_host.py | DedicatedHostManager.cancel_guests | def cancel_guests(self, host_id):
"""Cancel all guests into the dedicated host immediately.
To cancel an specified guest use the method VSManager.cancel_instance()
:param host_id: The ID of the dedicated host.
:return: The id, fqdn and status of all guests into a dictionary. The status
could be 'Cancelled' or an exception message, The dictionary is empty
if there isn't any guest in the dedicated host.
Example::
# Cancel guests of dedicated host id 12345
result = mgr.cancel_guests(12345)
"""
result = []
guests = self.host.getGuests(id=host_id, mask='id,fullyQualifiedDomainName')
if guests:
for vs in guests:
status_info = {
'id': vs['id'],
'fqdn': vs['fullyQualifiedDomainName'],
'status': self._delete_guest(vs['id'])
}
result.append(status_info)
return result | python | def cancel_guests(self, host_id):
result = []
guests = self.host.getGuests(id=host_id, mask='id,fullyQualifiedDomainName')
if guests:
for vs in guests:
status_info = {
'id': vs['id'],
'fqdn': vs['fullyQualifiedDomainName'],
'status': self._delete_guest(vs['id'])
}
result.append(status_info)
return result | [
"def",
"cancel_guests",
"(",
"self",
",",
"host_id",
")",
":",
"result",
"=",
"[",
"]",
"guests",
"=",
"self",
".",
"host",
".",
"getGuests",
"(",
"id",
"=",
"host_id",
",",
"mask",
"=",
"'id,fullyQualifiedDomainName'",
")",
"if",
"guests",
":",
"for",
"vs",
"in",
"guests",
":",
"status_info",
"=",
"{",
"'id'",
":",
"vs",
"[",
"'id'",
"]",
",",
"'fqdn'",
":",
"vs",
"[",
"'fullyQualifiedDomainName'",
"]",
",",
"'status'",
":",
"self",
".",
"_delete_guest",
"(",
"vs",
"[",
"'id'",
"]",
")",
"}",
"result",
".",
"append",
"(",
"status_info",
")",
"return",
"result"
]
| Cancel all guests into the dedicated host immediately.
To cancel an specified guest use the method VSManager.cancel_instance()
:param host_id: The ID of the dedicated host.
:return: The id, fqdn and status of all guests into a dictionary. The status
could be 'Cancelled' or an exception message, The dictionary is empty
if there isn't any guest in the dedicated host.
Example::
# Cancel guests of dedicated host id 12345
result = mgr.cancel_guests(12345) | [
"Cancel",
"all",
"guests",
"into",
"the",
"dedicated",
"host",
"immediately",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/dedicated_host.py#L54-L81 |
softlayer/softlayer-python | SoftLayer/managers/dedicated_host.py | DedicatedHostManager.list_guests | def list_guests(self, host_id, tags=None, cpus=None, memory=None, hostname=None,
domain=None, local_disk=None, nic_speed=None, public_ip=None,
private_ip=None, **kwargs):
"""Retrieve a list of all virtual servers on the dedicated host.
Example::
# Print out a list of instances with 4 cpu cores in the host id 12345.
for vsi in mgr.list_guests(host_id=12345, cpus=4):
print vsi['fullyQualifiedDomainName'], vsi['primaryIpAddress']
# Using a custom object-mask. Will get ONLY what is specified
object_mask = "mask[hostname,monitoringRobot[robotStatus]]"
for vsi in mgr.list_guests(mask=object_mask,cpus=4):
print vsi
:param integer host_id: the identifier of dedicated host
:param list tags: filter based on list of tags
:param integer cpus: filter based on number of CPUS
:param integer memory: filter based on amount of memory
:param string hostname: filter based on hostname
:param string domain: filter based on domain
:param string local_disk: filter based on local_disk
:param integer nic_speed: filter based on network speed (in MBPS)
:param string public_ip: filter based on public ip address
:param string private_ip: filter based on private ip address
:param dict \\*\\*kwargs: response-level options (mask, limit, etc.)
:returns: Returns a list of dictionaries representing the matching
virtual servers
"""
if 'mask' not in kwargs:
items = [
'id',
'globalIdentifier',
'hostname',
'domain',
'fullyQualifiedDomainName',
'primaryBackendIpAddress',
'primaryIpAddress',
'lastKnownPowerState.name',
'hourlyBillingFlag',
'powerState',
'maxCpu',
'maxMemory',
'datacenter',
'activeTransaction.transactionStatus[friendlyName,name]',
'status',
]
kwargs['mask'] = "mask[%s]" % ','.join(items)
_filter = utils.NestedDict(kwargs.get('filter') or {})
if tags:
_filter['guests']['tagReferences']['tag']['name'] = {
'operation': 'in',
'options': [{'name': 'data', 'value': tags}],
}
if cpus:
_filter['guests']['maxCpu'] = utils.query_filter(cpus)
if memory:
_filter['guests']['maxMemory'] = utils.query_filter(memory)
if hostname:
_filter['guests']['hostname'] = utils.query_filter(hostname)
if domain:
_filter['guests']['domain'] = utils.query_filter(domain)
if local_disk is not None:
_filter['guests']['localDiskFlag'] = (
utils.query_filter(bool(local_disk)))
if nic_speed:
_filter['guests']['networkComponents']['maxSpeed'] = (
utils.query_filter(nic_speed))
if public_ip:
_filter['guests']['primaryIpAddress'] = (
utils.query_filter(public_ip))
if private_ip:
_filter['guests']['primaryBackendIpAddress'] = (
utils.query_filter(private_ip))
kwargs['filter'] = _filter.to_dict()
kwargs['iter'] = True
return self.host.getGuests(id=host_id, **kwargs) | python | def list_guests(self, host_id, tags=None, cpus=None, memory=None, hostname=None,
domain=None, local_disk=None, nic_speed=None, public_ip=None,
private_ip=None, **kwargs):
if 'mask' not in kwargs:
items = [
'id',
'globalIdentifier',
'hostname',
'domain',
'fullyQualifiedDomainName',
'primaryBackendIpAddress',
'primaryIpAddress',
'lastKnownPowerState.name',
'hourlyBillingFlag',
'powerState',
'maxCpu',
'maxMemory',
'datacenter',
'activeTransaction.transactionStatus[friendlyName,name]',
'status',
]
kwargs['mask'] = "mask[%s]" % ','.join(items)
_filter = utils.NestedDict(kwargs.get('filter') or {})
if tags:
_filter['guests']['tagReferences']['tag']['name'] = {
'operation': 'in',
'options': [{'name': 'data', 'value': tags}],
}
if cpus:
_filter['guests']['maxCpu'] = utils.query_filter(cpus)
if memory:
_filter['guests']['maxMemory'] = utils.query_filter(memory)
if hostname:
_filter['guests']['hostname'] = utils.query_filter(hostname)
if domain:
_filter['guests']['domain'] = utils.query_filter(domain)
if local_disk is not None:
_filter['guests']['localDiskFlag'] = (
utils.query_filter(bool(local_disk)))
if nic_speed:
_filter['guests']['networkComponents']['maxSpeed'] = (
utils.query_filter(nic_speed))
if public_ip:
_filter['guests']['primaryIpAddress'] = (
utils.query_filter(public_ip))
if private_ip:
_filter['guests']['primaryBackendIpAddress'] = (
utils.query_filter(private_ip))
kwargs['filter'] = _filter.to_dict()
kwargs['iter'] = True
return self.host.getGuests(id=host_id, **kwargs) | [
"def",
"list_guests",
"(",
"self",
",",
"host_id",
",",
"tags",
"=",
"None",
",",
"cpus",
"=",
"None",
",",
"memory",
"=",
"None",
",",
"hostname",
"=",
"None",
",",
"domain",
"=",
"None",
",",
"local_disk",
"=",
"None",
",",
"nic_speed",
"=",
"None",
",",
"public_ip",
"=",
"None",
",",
"private_ip",
"=",
"None",
",",
"*",
"*",
"kwargs",
")",
":",
"if",
"'mask'",
"not",
"in",
"kwargs",
":",
"items",
"=",
"[",
"'id'",
",",
"'globalIdentifier'",
",",
"'hostname'",
",",
"'domain'",
",",
"'fullyQualifiedDomainName'",
",",
"'primaryBackendIpAddress'",
",",
"'primaryIpAddress'",
",",
"'lastKnownPowerState.name'",
",",
"'hourlyBillingFlag'",
",",
"'powerState'",
",",
"'maxCpu'",
",",
"'maxMemory'",
",",
"'datacenter'",
",",
"'activeTransaction.transactionStatus[friendlyName,name]'",
",",
"'status'",
",",
"]",
"kwargs",
"[",
"'mask'",
"]",
"=",
"\"mask[%s]\"",
"%",
"','",
".",
"join",
"(",
"items",
")",
"_filter",
"=",
"utils",
".",
"NestedDict",
"(",
"kwargs",
".",
"get",
"(",
"'filter'",
")",
"or",
"{",
"}",
")",
"if",
"tags",
":",
"_filter",
"[",
"'guests'",
"]",
"[",
"'tagReferences'",
"]",
"[",
"'tag'",
"]",
"[",
"'name'",
"]",
"=",
"{",
"'operation'",
":",
"'in'",
",",
"'options'",
":",
"[",
"{",
"'name'",
":",
"'data'",
",",
"'value'",
":",
"tags",
"}",
"]",
",",
"}",
"if",
"cpus",
":",
"_filter",
"[",
"'guests'",
"]",
"[",
"'maxCpu'",
"]",
"=",
"utils",
".",
"query_filter",
"(",
"cpus",
")",
"if",
"memory",
":",
"_filter",
"[",
"'guests'",
"]",
"[",
"'maxMemory'",
"]",
"=",
"utils",
".",
"query_filter",
"(",
"memory",
")",
"if",
"hostname",
":",
"_filter",
"[",
"'guests'",
"]",
"[",
"'hostname'",
"]",
"=",
"utils",
".",
"query_filter",
"(",
"hostname",
")",
"if",
"domain",
":",
"_filter",
"[",
"'guests'",
"]",
"[",
"'domain'",
"]",
"=",
"utils",
".",
"query_filter",
"(",
"domain",
")",
"if",
"local_disk",
"is",
"not",
"None",
":",
"_filter",
"[",
"'guests'",
"]",
"[",
"'localDiskFlag'",
"]",
"=",
"(",
"utils",
".",
"query_filter",
"(",
"bool",
"(",
"local_disk",
")",
")",
")",
"if",
"nic_speed",
":",
"_filter",
"[",
"'guests'",
"]",
"[",
"'networkComponents'",
"]",
"[",
"'maxSpeed'",
"]",
"=",
"(",
"utils",
".",
"query_filter",
"(",
"nic_speed",
")",
")",
"if",
"public_ip",
":",
"_filter",
"[",
"'guests'",
"]",
"[",
"'primaryIpAddress'",
"]",
"=",
"(",
"utils",
".",
"query_filter",
"(",
"public_ip",
")",
")",
"if",
"private_ip",
":",
"_filter",
"[",
"'guests'",
"]",
"[",
"'primaryBackendIpAddress'",
"]",
"=",
"(",
"utils",
".",
"query_filter",
"(",
"private_ip",
")",
")",
"kwargs",
"[",
"'filter'",
"]",
"=",
"_filter",
".",
"to_dict",
"(",
")",
"kwargs",
"[",
"'iter'",
"]",
"=",
"True",
"return",
"self",
".",
"host",
".",
"getGuests",
"(",
"id",
"=",
"host_id",
",",
"*",
"*",
"kwargs",
")"
]
| Retrieve a list of all virtual servers on the dedicated host.
Example::
# Print out a list of instances with 4 cpu cores in the host id 12345.
for vsi in mgr.list_guests(host_id=12345, cpus=4):
print vsi['fullyQualifiedDomainName'], vsi['primaryIpAddress']
# Using a custom object-mask. Will get ONLY what is specified
object_mask = "mask[hostname,monitoringRobot[robotStatus]]"
for vsi in mgr.list_guests(mask=object_mask,cpus=4):
print vsi
:param integer host_id: the identifier of dedicated host
:param list tags: filter based on list of tags
:param integer cpus: filter based on number of CPUS
:param integer memory: filter based on amount of memory
:param string hostname: filter based on hostname
:param string domain: filter based on domain
:param string local_disk: filter based on local_disk
:param integer nic_speed: filter based on network speed (in MBPS)
:param string public_ip: filter based on public ip address
:param string private_ip: filter based on private ip address
:param dict \\*\\*kwargs: response-level options (mask, limit, etc.)
:returns: Returns a list of dictionaries representing the matching
virtual servers | [
"Retrieve",
"a",
"list",
"of",
"all",
"virtual",
"servers",
"on",
"the",
"dedicated",
"host",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/dedicated_host.py#L83-L172 |
softlayer/softlayer-python | SoftLayer/managers/dedicated_host.py | DedicatedHostManager.list_instances | def list_instances(self, tags=None, cpus=None, memory=None, hostname=None,
disk=None, datacenter=None, **kwargs):
"""Retrieve a list of all dedicated hosts on the account
:param list tags: filter based on list of tags
:param integer cpus: filter based on number of CPUS
:param integer memory: filter based on amount of memory
:param string hostname: filter based on hostname
:param string disk: filter based on disk
:param string datacenter: filter based on datacenter
:param dict \\*\\*kwargs: response-level options (mask, limit, etc.)
:returns: Returns a list of dictionaries representing the matching dedicated host.
"""
if 'mask' not in kwargs:
items = [
'id',
'name',
'cpuCount',
'diskCapacity',
'memoryCapacity',
'datacenter',
'guestCount',
]
kwargs['mask'] = "mask[%s]" % ','.join(items)
_filter = utils.NestedDict(kwargs.get('filter') or {})
if tags:
_filter['dedicatedHosts']['tagReferences']['tag']['name'] = {
'operation': 'in',
'options': [{'name': 'data', 'value': tags}],
}
if hostname:
_filter['dedicatedHosts']['name'] = (
utils.query_filter(hostname)
)
if cpus:
_filter['dedicatedHosts']['cpuCount'] = utils.query_filter(cpus)
if disk:
_filter['dedicatedHosts']['diskCapacity'] = (
utils.query_filter(disk))
if memory:
_filter['dedicatedHosts']['memoryCapacity'] = (
utils.query_filter(memory))
if datacenter:
_filter['dedicatedHosts']['datacenter']['name'] = (
utils.query_filter(datacenter))
kwargs['filter'] = _filter.to_dict()
return self.account.getDedicatedHosts(**kwargs) | python | def list_instances(self, tags=None, cpus=None, memory=None, hostname=None,
disk=None, datacenter=None, **kwargs):
if 'mask' not in kwargs:
items = [
'id',
'name',
'cpuCount',
'diskCapacity',
'memoryCapacity',
'datacenter',
'guestCount',
]
kwargs['mask'] = "mask[%s]" % ','.join(items)
_filter = utils.NestedDict(kwargs.get('filter') or {})
if tags:
_filter['dedicatedHosts']['tagReferences']['tag']['name'] = {
'operation': 'in',
'options': [{'name': 'data', 'value': tags}],
}
if hostname:
_filter['dedicatedHosts']['name'] = (
utils.query_filter(hostname)
)
if cpus:
_filter['dedicatedHosts']['cpuCount'] = utils.query_filter(cpus)
if disk:
_filter['dedicatedHosts']['diskCapacity'] = (
utils.query_filter(disk))
if memory:
_filter['dedicatedHosts']['memoryCapacity'] = (
utils.query_filter(memory))
if datacenter:
_filter['dedicatedHosts']['datacenter']['name'] = (
utils.query_filter(datacenter))
kwargs['filter'] = _filter.to_dict()
return self.account.getDedicatedHosts(**kwargs) | [
"def",
"list_instances",
"(",
"self",
",",
"tags",
"=",
"None",
",",
"cpus",
"=",
"None",
",",
"memory",
"=",
"None",
",",
"hostname",
"=",
"None",
",",
"disk",
"=",
"None",
",",
"datacenter",
"=",
"None",
",",
"*",
"*",
"kwargs",
")",
":",
"if",
"'mask'",
"not",
"in",
"kwargs",
":",
"items",
"=",
"[",
"'id'",
",",
"'name'",
",",
"'cpuCount'",
",",
"'diskCapacity'",
",",
"'memoryCapacity'",
",",
"'datacenter'",
",",
"'guestCount'",
",",
"]",
"kwargs",
"[",
"'mask'",
"]",
"=",
"\"mask[%s]\"",
"%",
"','",
".",
"join",
"(",
"items",
")",
"_filter",
"=",
"utils",
".",
"NestedDict",
"(",
"kwargs",
".",
"get",
"(",
"'filter'",
")",
"or",
"{",
"}",
")",
"if",
"tags",
":",
"_filter",
"[",
"'dedicatedHosts'",
"]",
"[",
"'tagReferences'",
"]",
"[",
"'tag'",
"]",
"[",
"'name'",
"]",
"=",
"{",
"'operation'",
":",
"'in'",
",",
"'options'",
":",
"[",
"{",
"'name'",
":",
"'data'",
",",
"'value'",
":",
"tags",
"}",
"]",
",",
"}",
"if",
"hostname",
":",
"_filter",
"[",
"'dedicatedHosts'",
"]",
"[",
"'name'",
"]",
"=",
"(",
"utils",
".",
"query_filter",
"(",
"hostname",
")",
")",
"if",
"cpus",
":",
"_filter",
"[",
"'dedicatedHosts'",
"]",
"[",
"'cpuCount'",
"]",
"=",
"utils",
".",
"query_filter",
"(",
"cpus",
")",
"if",
"disk",
":",
"_filter",
"[",
"'dedicatedHosts'",
"]",
"[",
"'diskCapacity'",
"]",
"=",
"(",
"utils",
".",
"query_filter",
"(",
"disk",
")",
")",
"if",
"memory",
":",
"_filter",
"[",
"'dedicatedHosts'",
"]",
"[",
"'memoryCapacity'",
"]",
"=",
"(",
"utils",
".",
"query_filter",
"(",
"memory",
")",
")",
"if",
"datacenter",
":",
"_filter",
"[",
"'dedicatedHosts'",
"]",
"[",
"'datacenter'",
"]",
"[",
"'name'",
"]",
"=",
"(",
"utils",
".",
"query_filter",
"(",
"datacenter",
")",
")",
"kwargs",
"[",
"'filter'",
"]",
"=",
"_filter",
".",
"to_dict",
"(",
")",
"return",
"self",
".",
"account",
".",
"getDedicatedHosts",
"(",
"*",
"*",
"kwargs",
")"
]
| Retrieve a list of all dedicated hosts on the account
:param list tags: filter based on list of tags
:param integer cpus: filter based on number of CPUS
:param integer memory: filter based on amount of memory
:param string hostname: filter based on hostname
:param string disk: filter based on disk
:param string datacenter: filter based on datacenter
:param dict \\*\\*kwargs: response-level options (mask, limit, etc.)
:returns: Returns a list of dictionaries representing the matching dedicated host. | [
"Retrieve",
"a",
"list",
"of",
"all",
"dedicated",
"hosts",
"on",
"the",
"account"
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/dedicated_host.py#L174-L228 |
softlayer/softlayer-python | SoftLayer/managers/dedicated_host.py | DedicatedHostManager.get_host | def get_host(self, host_id, **kwargs):
"""Get details about a dedicated host.
:param integer : the host ID
:returns: A dictionary containing host information.
Example::
# Print out host ID 12345.
dh = mgr.get_host(12345)
print dh
# Print out only name and backendRouter for instance 12345
object_mask = "mask[name,backendRouter[id]]"
dh = mgr.get_host(12345, mask=mask)
print dh
"""
if 'mask' not in kwargs:
kwargs['mask'] = ('''
id,
name,
cpuCount,
memoryCapacity,
diskCapacity,
createDate,
modifyDate,
backendRouter[
id,
hostname,
domain
],
billingItem[
id,
nextInvoiceTotalRecurringAmount,
children[
categoryCode,
nextInvoiceTotalRecurringAmount
],
orderItem[
id,
order.userRecord[
username
]
]
],
datacenter[
id,
name,
longName
],
guests[
id,
hostname,
domain,
uuid
],
guestCount
''')
return self.host.getObject(id=host_id, **kwargs) | python | def get_host(self, host_id, **kwargs):
if 'mask' not in kwargs:
kwargs['mask'] = ()
return self.host.getObject(id=host_id, **kwargs) | [
"def",
"get_host",
"(",
"self",
",",
"host_id",
",",
"*",
"*",
"kwargs",
")",
":",
"if",
"'mask'",
"not",
"in",
"kwargs",
":",
"kwargs",
"[",
"'mask'",
"]",
"=",
"(",
"'''\n id,\n name,\n cpuCount,\n memoryCapacity,\n diskCapacity,\n createDate,\n modifyDate,\n backendRouter[\n id,\n hostname,\n domain\n ],\n billingItem[\n id,\n nextInvoiceTotalRecurringAmount,\n children[\n categoryCode,\n nextInvoiceTotalRecurringAmount\n ],\n orderItem[\n id,\n order.userRecord[\n username\n ]\n ]\n ],\n datacenter[\n id,\n name,\n longName\n ],\n guests[\n id,\n hostname,\n domain,\n uuid\n ],\n guestCount\n '''",
")",
"return",
"self",
".",
"host",
".",
"getObject",
"(",
"id",
"=",
"host_id",
",",
"*",
"*",
"kwargs",
")"
]
| Get details about a dedicated host.
:param integer : the host ID
:returns: A dictionary containing host information.
Example::
# Print out host ID 12345.
dh = mgr.get_host(12345)
print dh
# Print out only name and backendRouter for instance 12345
object_mask = "mask[name,backendRouter[id]]"
dh = mgr.get_host(12345, mask=mask)
print dh | [
"Get",
"details",
"about",
"a",
"dedicated",
"host",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/dedicated_host.py#L230-L290 |
softlayer/softlayer-python | SoftLayer/managers/dedicated_host.py | DedicatedHostManager.place_order | def place_order(self, hostname, domain, location, flavor, hourly, router=None):
"""Places an order for a dedicated host.
See get_create_options() for valid arguments.
:param string hostname: server hostname
:param string domain: server domain name
:param string location: location (datacenter) name
:param boolean hourly: True if using hourly pricing (default).
False for monthly.
:param int router: an optional value for selecting a backend router
"""
create_options = self._generate_create_dict(hostname=hostname,
router=router,
domain=domain,
flavor=flavor,
datacenter=location,
hourly=hourly)
return self.client['Product_Order'].placeOrder(create_options) | python | def place_order(self, hostname, domain, location, flavor, hourly, router=None):
create_options = self._generate_create_dict(hostname=hostname,
router=router,
domain=domain,
flavor=flavor,
datacenter=location,
hourly=hourly)
return self.client['Product_Order'].placeOrder(create_options) | [
"def",
"place_order",
"(",
"self",
",",
"hostname",
",",
"domain",
",",
"location",
",",
"flavor",
",",
"hourly",
",",
"router",
"=",
"None",
")",
":",
"create_options",
"=",
"self",
".",
"_generate_create_dict",
"(",
"hostname",
"=",
"hostname",
",",
"router",
"=",
"router",
",",
"domain",
"=",
"domain",
",",
"flavor",
"=",
"flavor",
",",
"datacenter",
"=",
"location",
",",
"hourly",
"=",
"hourly",
")",
"return",
"self",
".",
"client",
"[",
"'Product_Order'",
"]",
".",
"placeOrder",
"(",
"create_options",
")"
]
| Places an order for a dedicated host.
See get_create_options() for valid arguments.
:param string hostname: server hostname
:param string domain: server domain name
:param string location: location (datacenter) name
:param boolean hourly: True if using hourly pricing (default).
False for monthly.
:param int router: an optional value for selecting a backend router | [
"Places",
"an",
"order",
"for",
"a",
"dedicated",
"host",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/dedicated_host.py#L292-L311 |
softlayer/softlayer-python | SoftLayer/managers/dedicated_host.py | DedicatedHostManager.verify_order | def verify_order(self, hostname, domain, location, hourly, flavor, router=None):
"""Verifies an order for a dedicated host.
See :func:`place_order` for a list of available options.
"""
create_options = self._generate_create_dict(hostname=hostname,
router=router,
domain=domain,
flavor=flavor,
datacenter=location,
hourly=hourly)
return self.client['Product_Order'].verifyOrder(create_options) | python | def verify_order(self, hostname, domain, location, hourly, flavor, router=None):
create_options = self._generate_create_dict(hostname=hostname,
router=router,
domain=domain,
flavor=flavor,
datacenter=location,
hourly=hourly)
return self.client['Product_Order'].verifyOrder(create_options) | [
"def",
"verify_order",
"(",
"self",
",",
"hostname",
",",
"domain",
",",
"location",
",",
"hourly",
",",
"flavor",
",",
"router",
"=",
"None",
")",
":",
"create_options",
"=",
"self",
".",
"_generate_create_dict",
"(",
"hostname",
"=",
"hostname",
",",
"router",
"=",
"router",
",",
"domain",
"=",
"domain",
",",
"flavor",
"=",
"flavor",
",",
"datacenter",
"=",
"location",
",",
"hourly",
"=",
"hourly",
")",
"return",
"self",
".",
"client",
"[",
"'Product_Order'",
"]",
".",
"verifyOrder",
"(",
"create_options",
")"
]
| Verifies an order for a dedicated host.
See :func:`place_order` for a list of available options. | [
"Verifies",
"an",
"order",
"for",
"a",
"dedicated",
"host",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/dedicated_host.py#L313-L326 |
softlayer/softlayer-python | SoftLayer/managers/dedicated_host.py | DedicatedHostManager._generate_create_dict | def _generate_create_dict(self,
hostname=None,
domain=None,
flavor=None,
router=None,
datacenter=None,
hourly=True):
"""Translates args into a dictionary for creating a dedicated host."""
package = self._get_package()
item = self._get_item(package, flavor)
location = self._get_location(package['regions'], datacenter)
price = self._get_price(item)
routers = self._get_backend_router(
location['location']['locationPackageDetails'], item)
router = self._get_default_router(routers, router)
hardware = {
'hostname': hostname,
'domain': domain,
'primaryBackendNetworkComponent': {
'router': {
'id': router
}
}
}
complex_type = "SoftLayer_Container_Product_Order_Virtual_DedicatedHost"
order = {
"complexType": complex_type,
"quantity": 1,
'location': location['keyname'],
'packageId': package['id'],
'prices': [{'id': price}],
'hardware': [hardware],
'useHourlyPricing': hourly,
}
return order | python | def _generate_create_dict(self,
hostname=None,
domain=None,
flavor=None,
router=None,
datacenter=None,
hourly=True):
package = self._get_package()
item = self._get_item(package, flavor)
location = self._get_location(package['regions'], datacenter)
price = self._get_price(item)
routers = self._get_backend_router(
location['location']['locationPackageDetails'], item)
router = self._get_default_router(routers, router)
hardware = {
'hostname': hostname,
'domain': domain,
'primaryBackendNetworkComponent': {
'router': {
'id': router
}
}
}
complex_type = "SoftLayer_Container_Product_Order_Virtual_DedicatedHost"
order = {
"complexType": complex_type,
"quantity": 1,
'location': location['keyname'],
'packageId': package['id'],
'prices': [{'id': price}],
'hardware': [hardware],
'useHourlyPricing': hourly,
}
return order | [
"def",
"_generate_create_dict",
"(",
"self",
",",
"hostname",
"=",
"None",
",",
"domain",
"=",
"None",
",",
"flavor",
"=",
"None",
",",
"router",
"=",
"None",
",",
"datacenter",
"=",
"None",
",",
"hourly",
"=",
"True",
")",
":",
"package",
"=",
"self",
".",
"_get_package",
"(",
")",
"item",
"=",
"self",
".",
"_get_item",
"(",
"package",
",",
"flavor",
")",
"location",
"=",
"self",
".",
"_get_location",
"(",
"package",
"[",
"'regions'",
"]",
",",
"datacenter",
")",
"price",
"=",
"self",
".",
"_get_price",
"(",
"item",
")",
"routers",
"=",
"self",
".",
"_get_backend_router",
"(",
"location",
"[",
"'location'",
"]",
"[",
"'locationPackageDetails'",
"]",
",",
"item",
")",
"router",
"=",
"self",
".",
"_get_default_router",
"(",
"routers",
",",
"router",
")",
"hardware",
"=",
"{",
"'hostname'",
":",
"hostname",
",",
"'domain'",
":",
"domain",
",",
"'primaryBackendNetworkComponent'",
":",
"{",
"'router'",
":",
"{",
"'id'",
":",
"router",
"}",
"}",
"}",
"complex_type",
"=",
"\"SoftLayer_Container_Product_Order_Virtual_DedicatedHost\"",
"order",
"=",
"{",
"\"complexType\"",
":",
"complex_type",
",",
"\"quantity\"",
":",
"1",
",",
"'location'",
":",
"location",
"[",
"'keyname'",
"]",
",",
"'packageId'",
":",
"package",
"[",
"'id'",
"]",
",",
"'prices'",
":",
"[",
"{",
"'id'",
":",
"price",
"}",
"]",
",",
"'hardware'",
":",
"[",
"hardware",
"]",
",",
"'useHourlyPricing'",
":",
"hourly",
",",
"}",
"return",
"order"
]
| Translates args into a dictionary for creating a dedicated host. | [
"Translates",
"args",
"into",
"a",
"dictionary",
"for",
"creating",
"a",
"dedicated",
"host",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/dedicated_host.py#L328-L368 |
softlayer/softlayer-python | SoftLayer/managers/dedicated_host.py | DedicatedHostManager._get_location | def _get_location(self, regions, datacenter):
"""Get the longer key with a short location(datacenter) name."""
for region in regions:
# list of locations
if region['location']['location']['name'] == datacenter:
return region
raise SoftLayer.SoftLayerError("Could not find valid location for: '%s'" % datacenter) | python | def _get_location(self, regions, datacenter):
for region in regions:
if region['location']['location']['name'] == datacenter:
return region
raise SoftLayer.SoftLayerError("Could not find valid location for: '%s'" % datacenter) | [
"def",
"_get_location",
"(",
"self",
",",
"regions",
",",
"datacenter",
")",
":",
"for",
"region",
"in",
"regions",
":",
"# list of locations",
"if",
"region",
"[",
"'location'",
"]",
"[",
"'location'",
"]",
"[",
"'name'",
"]",
"==",
"datacenter",
":",
"return",
"region",
"raise",
"SoftLayer",
".",
"SoftLayerError",
"(",
"\"Could not find valid location for: '%s'\"",
"%",
"datacenter",
")"
]
| Get the longer key with a short location(datacenter) name. | [
"Get",
"the",
"longer",
"key",
"with",
"a",
"short",
"location",
"(",
"datacenter",
")",
"name",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/dedicated_host.py#L391-L398 |
softlayer/softlayer-python | SoftLayer/managers/dedicated_host.py | DedicatedHostManager.get_create_options | def get_create_options(self):
"""Returns valid options for ordering a dedicated host."""
package = self._get_package()
# Locations
locations = []
for region in package['regions']:
locations.append({
'name': region['location']['location']['longName'],
'key': region['location']['location']['name'],
})
# flavors
dedicated_host = []
for item in package['items']:
if item['itemCategory']['categoryCode'] == \
'dedicated_virtual_hosts':
dedicated_host.append({
'name': item['description'],
'key': item['keyName'],
})
return {'locations': locations, 'dedicated_host': dedicated_host} | python | def get_create_options(self):
package = self._get_package()
locations = []
for region in package['regions']:
locations.append({
'name': region['location']['location']['longName'],
'key': region['location']['location']['name'],
})
dedicated_host = []
for item in package['items']:
if item['itemCategory']['categoryCode'] == \
'dedicated_virtual_hosts':
dedicated_host.append({
'name': item['description'],
'key': item['keyName'],
})
return {'locations': locations, 'dedicated_host': dedicated_host} | [
"def",
"get_create_options",
"(",
"self",
")",
":",
"package",
"=",
"self",
".",
"_get_package",
"(",
")",
"# Locations",
"locations",
"=",
"[",
"]",
"for",
"region",
"in",
"package",
"[",
"'regions'",
"]",
":",
"locations",
".",
"append",
"(",
"{",
"'name'",
":",
"region",
"[",
"'location'",
"]",
"[",
"'location'",
"]",
"[",
"'longName'",
"]",
",",
"'key'",
":",
"region",
"[",
"'location'",
"]",
"[",
"'location'",
"]",
"[",
"'name'",
"]",
",",
"}",
")",
"# flavors",
"dedicated_host",
"=",
"[",
"]",
"for",
"item",
"in",
"package",
"[",
"'items'",
"]",
":",
"if",
"item",
"[",
"'itemCategory'",
"]",
"[",
"'categoryCode'",
"]",
"==",
"'dedicated_virtual_hosts'",
":",
"dedicated_host",
".",
"append",
"(",
"{",
"'name'",
":",
"item",
"[",
"'description'",
"]",
",",
"'key'",
":",
"item",
"[",
"'keyName'",
"]",
",",
"}",
")",
"return",
"{",
"'locations'",
":",
"locations",
",",
"'dedicated_host'",
":",
"dedicated_host",
"}"
]
| Returns valid options for ordering a dedicated host. | [
"Returns",
"valid",
"options",
"for",
"ordering",
"a",
"dedicated",
"host",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/dedicated_host.py#L400-L420 |
softlayer/softlayer-python | SoftLayer/managers/dedicated_host.py | DedicatedHostManager._get_price | def _get_price(self, package):
"""Returns valid price for ordering a dedicated host."""
for price in package['prices']:
if not price.get('locationGroupId'):
return price['id']
raise SoftLayer.SoftLayerError("Could not find valid price") | python | def _get_price(self, package):
for price in package['prices']:
if not price.get('locationGroupId'):
return price['id']
raise SoftLayer.SoftLayerError("Could not find valid price") | [
"def",
"_get_price",
"(",
"self",
",",
"package",
")",
":",
"for",
"price",
"in",
"package",
"[",
"'prices'",
"]",
":",
"if",
"not",
"price",
".",
"get",
"(",
"'locationGroupId'",
")",
":",
"return",
"price",
"[",
"'id'",
"]",
"raise",
"SoftLayer",
".",
"SoftLayerError",
"(",
"\"Could not find valid price\"",
")"
]
| Returns valid price for ordering a dedicated host. | [
"Returns",
"valid",
"price",
"for",
"ordering",
"a",
"dedicated",
"host",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/dedicated_host.py#L422-L429 |
softlayer/softlayer-python | SoftLayer/managers/dedicated_host.py | DedicatedHostManager._get_item | def _get_item(self, package, flavor):
"""Returns the item for ordering a dedicated host."""
for item in package['items']:
if item['keyName'] == flavor:
return item
raise SoftLayer.SoftLayerError("Could not find valid item for: '%s'" % flavor) | python | def _get_item(self, package, flavor):
for item in package['items']:
if item['keyName'] == flavor:
return item
raise SoftLayer.SoftLayerError("Could not find valid item for: '%s'" % flavor) | [
"def",
"_get_item",
"(",
"self",
",",
"package",
",",
"flavor",
")",
":",
"for",
"item",
"in",
"package",
"[",
"'items'",
"]",
":",
"if",
"item",
"[",
"'keyName'",
"]",
"==",
"flavor",
":",
"return",
"item",
"raise",
"SoftLayer",
".",
"SoftLayerError",
"(",
"\"Could not find valid item for: '%s'\"",
"%",
"flavor",
")"
]
| Returns the item for ordering a dedicated host. | [
"Returns",
"the",
"item",
"for",
"ordering",
"a",
"dedicated",
"host",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/dedicated_host.py#L431-L438 |
softlayer/softlayer-python | SoftLayer/managers/dedicated_host.py | DedicatedHostManager._get_backend_router | def _get_backend_router(self, locations, item):
"""Returns valid router options for ordering a dedicated host."""
mask = '''
id,
hostname
'''
cpu_count = item['capacity']
for capacity in item['bundleItems']:
for category in capacity['categories']:
if category['categoryCode'] == 'dedicated_host_ram':
mem_capacity = capacity['capacity']
if category['categoryCode'] == 'dedicated_host_disk':
disk_capacity = capacity['capacity']
for hardwareComponent in item['bundleItems']:
if hardwareComponent['keyName'].find("GPU") != -1:
hardwareComponentType = hardwareComponent['hardwareGenericComponentModel']['hardwareComponentType']
gpuComponents = [
{
'hardwareComponentModel': {
'hardwareGenericComponentModel': {
'id': hardwareComponent['hardwareGenericComponentModel']['id'],
'hardwareComponentType': {
'keyName': hardwareComponentType['keyName']
}
}
}
},
{
'hardwareComponentModel': {
'hardwareGenericComponentModel': {
'id': hardwareComponent['hardwareGenericComponentModel']['id'],
'hardwareComponentType': {
'keyName': hardwareComponentType['keyName']
}
}
}
}
]
if locations is not None:
for location in locations:
if location['locationId'] is not None:
loc_id = location['locationId']
host = {
'cpuCount': cpu_count,
'memoryCapacity': mem_capacity,
'diskCapacity': disk_capacity,
'datacenter': {
'id': loc_id
}
}
if item['keyName'].find("GPU") != -1:
host['pciDevices'] = gpuComponents
routers = self.host.getAvailableRouters(host, mask=mask)
return routers
raise SoftLayer.SoftLayerError("Could not find available routers") | python | def _get_backend_router(self, locations, item):
mask =
cpu_count = item['capacity']
for capacity in item['bundleItems']:
for category in capacity['categories']:
if category['categoryCode'] == 'dedicated_host_ram':
mem_capacity = capacity['capacity']
if category['categoryCode'] == 'dedicated_host_disk':
disk_capacity = capacity['capacity']
for hardwareComponent in item['bundleItems']:
if hardwareComponent['keyName'].find("GPU") != -1:
hardwareComponentType = hardwareComponent['hardwareGenericComponentModel']['hardwareComponentType']
gpuComponents = [
{
'hardwareComponentModel': {
'hardwareGenericComponentModel': {
'id': hardwareComponent['hardwareGenericComponentModel']['id'],
'hardwareComponentType': {
'keyName': hardwareComponentType['keyName']
}
}
}
},
{
'hardwareComponentModel': {
'hardwareGenericComponentModel': {
'id': hardwareComponent['hardwareGenericComponentModel']['id'],
'hardwareComponentType': {
'keyName': hardwareComponentType['keyName']
}
}
}
}
]
if locations is not None:
for location in locations:
if location['locationId'] is not None:
loc_id = location['locationId']
host = {
'cpuCount': cpu_count,
'memoryCapacity': mem_capacity,
'diskCapacity': disk_capacity,
'datacenter': {
'id': loc_id
}
}
if item['keyName'].find("GPU") != -1:
host['pciDevices'] = gpuComponents
routers = self.host.getAvailableRouters(host, mask=mask)
return routers
raise SoftLayer.SoftLayerError("Could not find available routers") | [
"def",
"_get_backend_router",
"(",
"self",
",",
"locations",
",",
"item",
")",
":",
"mask",
"=",
"'''\n id,\n hostname\n '''",
"cpu_count",
"=",
"item",
"[",
"'capacity'",
"]",
"for",
"capacity",
"in",
"item",
"[",
"'bundleItems'",
"]",
":",
"for",
"category",
"in",
"capacity",
"[",
"'categories'",
"]",
":",
"if",
"category",
"[",
"'categoryCode'",
"]",
"==",
"'dedicated_host_ram'",
":",
"mem_capacity",
"=",
"capacity",
"[",
"'capacity'",
"]",
"if",
"category",
"[",
"'categoryCode'",
"]",
"==",
"'dedicated_host_disk'",
":",
"disk_capacity",
"=",
"capacity",
"[",
"'capacity'",
"]",
"for",
"hardwareComponent",
"in",
"item",
"[",
"'bundleItems'",
"]",
":",
"if",
"hardwareComponent",
"[",
"'keyName'",
"]",
".",
"find",
"(",
"\"GPU\"",
")",
"!=",
"-",
"1",
":",
"hardwareComponentType",
"=",
"hardwareComponent",
"[",
"'hardwareGenericComponentModel'",
"]",
"[",
"'hardwareComponentType'",
"]",
"gpuComponents",
"=",
"[",
"{",
"'hardwareComponentModel'",
":",
"{",
"'hardwareGenericComponentModel'",
":",
"{",
"'id'",
":",
"hardwareComponent",
"[",
"'hardwareGenericComponentModel'",
"]",
"[",
"'id'",
"]",
",",
"'hardwareComponentType'",
":",
"{",
"'keyName'",
":",
"hardwareComponentType",
"[",
"'keyName'",
"]",
"}",
"}",
"}",
"}",
",",
"{",
"'hardwareComponentModel'",
":",
"{",
"'hardwareGenericComponentModel'",
":",
"{",
"'id'",
":",
"hardwareComponent",
"[",
"'hardwareGenericComponentModel'",
"]",
"[",
"'id'",
"]",
",",
"'hardwareComponentType'",
":",
"{",
"'keyName'",
":",
"hardwareComponentType",
"[",
"'keyName'",
"]",
"}",
"}",
"}",
"}",
"]",
"if",
"locations",
"is",
"not",
"None",
":",
"for",
"location",
"in",
"locations",
":",
"if",
"location",
"[",
"'locationId'",
"]",
"is",
"not",
"None",
":",
"loc_id",
"=",
"location",
"[",
"'locationId'",
"]",
"host",
"=",
"{",
"'cpuCount'",
":",
"cpu_count",
",",
"'memoryCapacity'",
":",
"mem_capacity",
",",
"'diskCapacity'",
":",
"disk_capacity",
",",
"'datacenter'",
":",
"{",
"'id'",
":",
"loc_id",
"}",
"}",
"if",
"item",
"[",
"'keyName'",
"]",
".",
"find",
"(",
"\"GPU\"",
")",
"!=",
"-",
"1",
":",
"host",
"[",
"'pciDevices'",
"]",
"=",
"gpuComponents",
"routers",
"=",
"self",
".",
"host",
".",
"getAvailableRouters",
"(",
"host",
",",
"mask",
"=",
"mask",
")",
"return",
"routers",
"raise",
"SoftLayer",
".",
"SoftLayerError",
"(",
"\"Could not find available routers\"",
")"
]
| Returns valid router options for ordering a dedicated host. | [
"Returns",
"valid",
"router",
"options",
"for",
"ordering",
"a",
"dedicated",
"host",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/dedicated_host.py#L440-L498 |
softlayer/softlayer-python | SoftLayer/managers/dedicated_host.py | DedicatedHostManager._get_default_router | def _get_default_router(self, routers, router_name=None):
"""Returns the default router for ordering a dedicated host."""
if router_name is None:
for router in routers:
if router['id'] is not None:
return router['id']
else:
for router in routers:
if router['hostname'] == router_name:
return router['id']
raise SoftLayer.SoftLayerError("Could not find valid default router") | python | def _get_default_router(self, routers, router_name=None):
if router_name is None:
for router in routers:
if router['id'] is not None:
return router['id']
else:
for router in routers:
if router['hostname'] == router_name:
return router['id']
raise SoftLayer.SoftLayerError("Could not find valid default router") | [
"def",
"_get_default_router",
"(",
"self",
",",
"routers",
",",
"router_name",
"=",
"None",
")",
":",
"if",
"router_name",
"is",
"None",
":",
"for",
"router",
"in",
"routers",
":",
"if",
"router",
"[",
"'id'",
"]",
"is",
"not",
"None",
":",
"return",
"router",
"[",
"'id'",
"]",
"else",
":",
"for",
"router",
"in",
"routers",
":",
"if",
"router",
"[",
"'hostname'",
"]",
"==",
"router_name",
":",
"return",
"router",
"[",
"'id'",
"]",
"raise",
"SoftLayer",
".",
"SoftLayerError",
"(",
"\"Could not find valid default router\"",
")"
]
| Returns the default router for ordering a dedicated host. | [
"Returns",
"the",
"default",
"router",
"for",
"ordering",
"a",
"dedicated",
"host",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/dedicated_host.py#L500-L511 |
softlayer/softlayer-python | SoftLayer/managers/dedicated_host.py | DedicatedHostManager.get_router_options | def get_router_options(self, datacenter=None, flavor=None):
"""Returns available backend routers for the dedicated host."""
package = self._get_package()
location = self._get_location(package['regions'], datacenter)
item = self._get_item(package, flavor)
return self._get_backend_router(location['location']['locationPackageDetails'], item) | python | def get_router_options(self, datacenter=None, flavor=None):
package = self._get_package()
location = self._get_location(package['regions'], datacenter)
item = self._get_item(package, flavor)
return self._get_backend_router(location['location']['locationPackageDetails'], item) | [
"def",
"get_router_options",
"(",
"self",
",",
"datacenter",
"=",
"None",
",",
"flavor",
"=",
"None",
")",
":",
"package",
"=",
"self",
".",
"_get_package",
"(",
")",
"location",
"=",
"self",
".",
"_get_location",
"(",
"package",
"[",
"'regions'",
"]",
",",
"datacenter",
")",
"item",
"=",
"self",
".",
"_get_item",
"(",
"package",
",",
"flavor",
")",
"return",
"self",
".",
"_get_backend_router",
"(",
"location",
"[",
"'location'",
"]",
"[",
"'locationPackageDetails'",
"]",
",",
"item",
")"
]
| Returns available backend routers for the dedicated host. | [
"Returns",
"available",
"backend",
"routers",
"for",
"the",
"dedicated",
"host",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/dedicated_host.py#L513-L520 |
softlayer/softlayer-python | SoftLayer/managers/dedicated_host.py | DedicatedHostManager._delete_guest | def _delete_guest(self, guest_id):
"""Deletes a guest and returns 'Cancelled' or and Exception message"""
msg = 'Cancelled'
try:
self.guest.deleteObject(id=guest_id)
except SoftLayer.SoftLayerAPIError as e:
msg = 'Exception: ' + e.faultString
return msg | python | def _delete_guest(self, guest_id):
msg = 'Cancelled'
try:
self.guest.deleteObject(id=guest_id)
except SoftLayer.SoftLayerAPIError as e:
msg = 'Exception: ' + e.faultString
return msg | [
"def",
"_delete_guest",
"(",
"self",
",",
"guest_id",
")",
":",
"msg",
"=",
"'Cancelled'",
"try",
":",
"self",
".",
"guest",
".",
"deleteObject",
"(",
"id",
"=",
"guest_id",
")",
"except",
"SoftLayer",
".",
"SoftLayerAPIError",
"as",
"e",
":",
"msg",
"=",
"'Exception: '",
"+",
"e",
".",
"faultString",
"return",
"msg"
]
| Deletes a guest and returns 'Cancelled' or and Exception message | [
"Deletes",
"a",
"guest",
"and",
"returns",
"Cancelled",
"or",
"and",
"Exception",
"message"
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/dedicated_host.py#L522-L530 |
softlayer/softlayer-python | SoftLayer/shell/completer.py | _click_autocomplete | def _click_autocomplete(root, text):
"""Completer generator for click applications."""
try:
parts = shlex.split(text)
except ValueError:
raise StopIteration
location, incomplete = _click_resolve_command(root, parts)
if not text.endswith(' ') and not incomplete and text:
raise StopIteration
if incomplete and not incomplete[0:2].isalnum():
for param in location.params:
if not isinstance(param, click.Option):
continue
for opt in itertools.chain(param.opts, param.secondary_opts):
if opt.startswith(incomplete):
yield completion.Completion(opt, -len(incomplete), display_meta=param.help)
elif isinstance(location, (click.MultiCommand, click.core.Group)):
ctx = click.Context(location)
commands = location.list_commands(ctx)
for command in commands:
if command.startswith(incomplete):
cmd = location.get_command(ctx, command)
yield completion.Completion(command, -len(incomplete), display_meta=cmd.short_help) | python | def _click_autocomplete(root, text):
try:
parts = shlex.split(text)
except ValueError:
raise StopIteration
location, incomplete = _click_resolve_command(root, parts)
if not text.endswith(' ') and not incomplete and text:
raise StopIteration
if incomplete and not incomplete[0:2].isalnum():
for param in location.params:
if not isinstance(param, click.Option):
continue
for opt in itertools.chain(param.opts, param.secondary_opts):
if opt.startswith(incomplete):
yield completion.Completion(opt, -len(incomplete), display_meta=param.help)
elif isinstance(location, (click.MultiCommand, click.core.Group)):
ctx = click.Context(location)
commands = location.list_commands(ctx)
for command in commands:
if command.startswith(incomplete):
cmd = location.get_command(ctx, command)
yield completion.Completion(command, -len(incomplete), display_meta=cmd.short_help) | [
"def",
"_click_autocomplete",
"(",
"root",
",",
"text",
")",
":",
"try",
":",
"parts",
"=",
"shlex",
".",
"split",
"(",
"text",
")",
"except",
"ValueError",
":",
"raise",
"StopIteration",
"location",
",",
"incomplete",
"=",
"_click_resolve_command",
"(",
"root",
",",
"parts",
")",
"if",
"not",
"text",
".",
"endswith",
"(",
"' '",
")",
"and",
"not",
"incomplete",
"and",
"text",
":",
"raise",
"StopIteration",
"if",
"incomplete",
"and",
"not",
"incomplete",
"[",
"0",
":",
"2",
"]",
".",
"isalnum",
"(",
")",
":",
"for",
"param",
"in",
"location",
".",
"params",
":",
"if",
"not",
"isinstance",
"(",
"param",
",",
"click",
".",
"Option",
")",
":",
"continue",
"for",
"opt",
"in",
"itertools",
".",
"chain",
"(",
"param",
".",
"opts",
",",
"param",
".",
"secondary_opts",
")",
":",
"if",
"opt",
".",
"startswith",
"(",
"incomplete",
")",
":",
"yield",
"completion",
".",
"Completion",
"(",
"opt",
",",
"-",
"len",
"(",
"incomplete",
")",
",",
"display_meta",
"=",
"param",
".",
"help",
")",
"elif",
"isinstance",
"(",
"location",
",",
"(",
"click",
".",
"MultiCommand",
",",
"click",
".",
"core",
".",
"Group",
")",
")",
":",
"ctx",
"=",
"click",
".",
"Context",
"(",
"location",
")",
"commands",
"=",
"location",
".",
"list_commands",
"(",
"ctx",
")",
"for",
"command",
"in",
"commands",
":",
"if",
"command",
".",
"startswith",
"(",
"incomplete",
")",
":",
"cmd",
"=",
"location",
".",
"get_command",
"(",
"ctx",
",",
"command",
")",
"yield",
"completion",
".",
"Completion",
"(",
"command",
",",
"-",
"len",
"(",
"incomplete",
")",
",",
"display_meta",
"=",
"cmd",
".",
"short_help",
")"
]
| Completer generator for click applications. | [
"Completer",
"generator",
"for",
"click",
"applications",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/shell/completer.py#L28-L54 |
softlayer/softlayer-python | SoftLayer/shell/completer.py | _click_resolve_command | def _click_resolve_command(root, parts):
"""Return the click command and the left over text given some vargs."""
location = root
incomplete = ''
for part in parts:
incomplete = part
if not part[0:2].isalnum():
continue
try:
next_location = location.get_command(click.Context(location),
part)
if next_location is not None:
location = next_location
incomplete = ''
except AttributeError:
break
return location, incomplete | python | def _click_resolve_command(root, parts):
location = root
incomplete = ''
for part in parts:
incomplete = part
if not part[0:2].isalnum():
continue
try:
next_location = location.get_command(click.Context(location),
part)
if next_location is not None:
location = next_location
incomplete = ''
except AttributeError:
break
return location, incomplete | [
"def",
"_click_resolve_command",
"(",
"root",
",",
"parts",
")",
":",
"location",
"=",
"root",
"incomplete",
"=",
"''",
"for",
"part",
"in",
"parts",
":",
"incomplete",
"=",
"part",
"if",
"not",
"part",
"[",
"0",
":",
"2",
"]",
".",
"isalnum",
"(",
")",
":",
"continue",
"try",
":",
"next_location",
"=",
"location",
".",
"get_command",
"(",
"click",
".",
"Context",
"(",
"location",
")",
",",
"part",
")",
"if",
"next_location",
"is",
"not",
"None",
":",
"location",
"=",
"next_location",
"incomplete",
"=",
"''",
"except",
"AttributeError",
":",
"break",
"return",
"location",
",",
"incomplete"
]
| Return the click command and the left over text given some vargs. | [
"Return",
"the",
"click",
"command",
"and",
"the",
"left",
"over",
"text",
"given",
"some",
"vargs",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/shell/completer.py#L57-L75 |
softlayer/softlayer-python | SoftLayer/CLI/user/edit_permissions.py | cli | def cli(env, identifier, enable, permission, from_user):
"""Enable or Disable specific permissions."""
mgr = SoftLayer.UserManager(env.client)
user_id = helpers.resolve_id(mgr.resolve_ids, identifier, 'username')
result = False
if from_user:
from_user_id = helpers.resolve_id(mgr.resolve_ids, from_user, 'username')
result = mgr.permissions_from_user(user_id, from_user_id)
elif enable:
result = mgr.add_permissions(user_id, permission)
else:
result = mgr.remove_permissions(user_id, permission)
if result:
click.secho("Permissions updated successfully: %s" % ", ".join(permission), fg='green')
else:
click.secho("Failed to update permissions: %s" % ", ".join(permission), fg='red') | python | def cli(env, identifier, enable, permission, from_user):
mgr = SoftLayer.UserManager(env.client)
user_id = helpers.resolve_id(mgr.resolve_ids, identifier, 'username')
result = False
if from_user:
from_user_id = helpers.resolve_id(mgr.resolve_ids, from_user, 'username')
result = mgr.permissions_from_user(user_id, from_user_id)
elif enable:
result = mgr.add_permissions(user_id, permission)
else:
result = mgr.remove_permissions(user_id, permission)
if result:
click.secho("Permissions updated successfully: %s" % ", ".join(permission), fg='green')
else:
click.secho("Failed to update permissions: %s" % ", ".join(permission), fg='red') | [
"def",
"cli",
"(",
"env",
",",
"identifier",
",",
"enable",
",",
"permission",
",",
"from_user",
")",
":",
"mgr",
"=",
"SoftLayer",
".",
"UserManager",
"(",
"env",
".",
"client",
")",
"user_id",
"=",
"helpers",
".",
"resolve_id",
"(",
"mgr",
".",
"resolve_ids",
",",
"identifier",
",",
"'username'",
")",
"result",
"=",
"False",
"if",
"from_user",
":",
"from_user_id",
"=",
"helpers",
".",
"resolve_id",
"(",
"mgr",
".",
"resolve_ids",
",",
"from_user",
",",
"'username'",
")",
"result",
"=",
"mgr",
".",
"permissions_from_user",
"(",
"user_id",
",",
"from_user_id",
")",
"elif",
"enable",
":",
"result",
"=",
"mgr",
".",
"add_permissions",
"(",
"user_id",
",",
"permission",
")",
"else",
":",
"result",
"=",
"mgr",
".",
"remove_permissions",
"(",
"user_id",
",",
"permission",
")",
"if",
"result",
":",
"click",
".",
"secho",
"(",
"\"Permissions updated successfully: %s\"",
"%",
"\", \"",
".",
"join",
"(",
"permission",
")",
",",
"fg",
"=",
"'green'",
")",
"else",
":",
"click",
".",
"secho",
"(",
"\"Failed to update permissions: %s\"",
"%",
"\", \"",
".",
"join",
"(",
"permission",
")",
",",
"fg",
"=",
"'red'",
")"
]
| Enable or Disable specific permissions. | [
"Enable",
"or",
"Disable",
"specific",
"permissions",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/CLI/user/edit_permissions.py#L22-L38 |
softlayer/softlayer-python | SoftLayer/managers/cdn.py | CDNManager.list_accounts | def list_accounts(self):
"""Lists CDN accounts for the active user."""
account = self.client['Account']
mask = 'cdnAccounts[%s]' % ', '.join(['id',
'createDate',
'cdnAccountName',
'cdnSolutionName',
'cdnAccountNote',
'status'])
return account.getObject(mask=mask).get('cdnAccounts', []) | python | def list_accounts(self):
account = self.client['Account']
mask = 'cdnAccounts[%s]' % ', '.join(['id',
'createDate',
'cdnAccountName',
'cdnSolutionName',
'cdnAccountNote',
'status'])
return account.getObject(mask=mask).get('cdnAccounts', []) | [
"def",
"list_accounts",
"(",
"self",
")",
":",
"account",
"=",
"self",
".",
"client",
"[",
"'Account'",
"]",
"mask",
"=",
"'cdnAccounts[%s]'",
"%",
"', '",
".",
"join",
"(",
"[",
"'id'",
",",
"'createDate'",
",",
"'cdnAccountName'",
",",
"'cdnSolutionName'",
",",
"'cdnAccountNote'",
",",
"'status'",
"]",
")",
"return",
"account",
".",
"getObject",
"(",
"mask",
"=",
"mask",
")",
".",
"get",
"(",
"'cdnAccounts'",
",",
"[",
"]",
")"
]
| Lists CDN accounts for the active user. | [
"Lists",
"CDN",
"accounts",
"for",
"the",
"active",
"user",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/cdn.py#L30-L40 |
softlayer/softlayer-python | SoftLayer/managers/cdn.py | CDNManager.get_account | def get_account(self, account_id, **kwargs):
"""Retrieves a CDN account with the specified account ID.
:param account_id int: the numeric ID associated with the CDN account.
:param dict \\*\\*kwargs: additional arguments to include in the object
mask.
"""
if 'mask' not in kwargs:
kwargs['mask'] = 'status'
return self.account.getObject(id=account_id, **kwargs) | python | def get_account(self, account_id, **kwargs):
if 'mask' not in kwargs:
kwargs['mask'] = 'status'
return self.account.getObject(id=account_id, **kwargs) | [
"def",
"get_account",
"(",
"self",
",",
"account_id",
",",
"*",
"*",
"kwargs",
")",
":",
"if",
"'mask'",
"not",
"in",
"kwargs",
":",
"kwargs",
"[",
"'mask'",
"]",
"=",
"'status'",
"return",
"self",
".",
"account",
".",
"getObject",
"(",
"id",
"=",
"account_id",
",",
"*",
"*",
"kwargs",
")"
]
| Retrieves a CDN account with the specified account ID.
:param account_id int: the numeric ID associated with the CDN account.
:param dict \\*\\*kwargs: additional arguments to include in the object
mask. | [
"Retrieves",
"a",
"CDN",
"account",
"with",
"the",
"specified",
"account",
"ID",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/cdn.py#L42-L53 |
softlayer/softlayer-python | SoftLayer/managers/cdn.py | CDNManager.get_origins | def get_origins(self, account_id, **kwargs):
"""Retrieves list of origin pull mappings for a specified CDN account.
:param account_id int: the numeric ID associated with the CDN account.
:param dict \\*\\*kwargs: additional arguments to include in the object
mask.
"""
return self.account.getOriginPullMappingInformation(id=account_id,
**kwargs) | python | def get_origins(self, account_id, **kwargs):
return self.account.getOriginPullMappingInformation(id=account_id,
**kwargs) | [
"def",
"get_origins",
"(",
"self",
",",
"account_id",
",",
"*",
"*",
"kwargs",
")",
":",
"return",
"self",
".",
"account",
".",
"getOriginPullMappingInformation",
"(",
"id",
"=",
"account_id",
",",
"*",
"*",
"kwargs",
")"
]
| Retrieves list of origin pull mappings for a specified CDN account.
:param account_id int: the numeric ID associated with the CDN account.
:param dict \\*\\*kwargs: additional arguments to include in the object
mask. | [
"Retrieves",
"list",
"of",
"origin",
"pull",
"mappings",
"for",
"a",
"specified",
"CDN",
"account",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/cdn.py#L55-L64 |
softlayer/softlayer-python | SoftLayer/managers/cdn.py | CDNManager.add_origin | def add_origin(self, account_id, media_type, origin_url, cname=None,
secure=False):
"""Adds an original pull mapping to an origin-pull.
:param int account_id: the numeric ID associated with the CDN account.
:param string media_type: the media type/protocol associated with this
origin pull mapping; valid values are HTTP,
FLASH, and WM.
:param string origin_url: the base URL from which content should be
pulled.
:param string cname: an optional CNAME that should be associated with
this origin pull rule; only the hostname should be
included (i.e., no 'http://', directories, etc.).
:param boolean secure: specifies whether this is an SSL origin pull
rule, if SSL is enabled on your account
(defaults to false).
"""
config = {'mediaType': media_type,
'originUrl': origin_url,
'isSecureContent': secure}
if cname:
config['cname'] = cname
return self.account.createOriginPullMapping(config, id=account_id) | python | def add_origin(self, account_id, media_type, origin_url, cname=None,
secure=False):
config = {'mediaType': media_type,
'originUrl': origin_url,
'isSecureContent': secure}
if cname:
config['cname'] = cname
return self.account.createOriginPullMapping(config, id=account_id) | [
"def",
"add_origin",
"(",
"self",
",",
"account_id",
",",
"media_type",
",",
"origin_url",
",",
"cname",
"=",
"None",
",",
"secure",
"=",
"False",
")",
":",
"config",
"=",
"{",
"'mediaType'",
":",
"media_type",
",",
"'originUrl'",
":",
"origin_url",
",",
"'isSecureContent'",
":",
"secure",
"}",
"if",
"cname",
":",
"config",
"[",
"'cname'",
"]",
"=",
"cname",
"return",
"self",
".",
"account",
".",
"createOriginPullMapping",
"(",
"config",
",",
"id",
"=",
"account_id",
")"
]
| Adds an original pull mapping to an origin-pull.
:param int account_id: the numeric ID associated with the CDN account.
:param string media_type: the media type/protocol associated with this
origin pull mapping; valid values are HTTP,
FLASH, and WM.
:param string origin_url: the base URL from which content should be
pulled.
:param string cname: an optional CNAME that should be associated with
this origin pull rule; only the hostname should be
included (i.e., no 'http://', directories, etc.).
:param boolean secure: specifies whether this is an SSL origin pull
rule, if SSL is enabled on your account
(defaults to false). | [
"Adds",
"an",
"original",
"pull",
"mapping",
"to",
"an",
"origin",
"-",
"pull",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/cdn.py#L66-L91 |
softlayer/softlayer-python | SoftLayer/managers/cdn.py | CDNManager.remove_origin | def remove_origin(self, account_id, origin_id):
"""Removes an origin pull mapping with the given origin pull ID.
:param int account_id: the CDN account ID from which the mapping should
be deleted.
:param int origin_id: the origin pull mapping ID to delete.
"""
return self.account.deleteOriginPullRule(origin_id, id=account_id) | python | def remove_origin(self, account_id, origin_id):
return self.account.deleteOriginPullRule(origin_id, id=account_id) | [
"def",
"remove_origin",
"(",
"self",
",",
"account_id",
",",
"origin_id",
")",
":",
"return",
"self",
".",
"account",
".",
"deleteOriginPullRule",
"(",
"origin_id",
",",
"id",
"=",
"account_id",
")"
]
| Removes an origin pull mapping with the given origin pull ID.
:param int account_id: the CDN account ID from which the mapping should
be deleted.
:param int origin_id: the origin pull mapping ID to delete. | [
"Removes",
"an",
"origin",
"pull",
"mapping",
"with",
"the",
"given",
"origin",
"pull",
"ID",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/cdn.py#L93-L101 |
softlayer/softlayer-python | SoftLayer/managers/cdn.py | CDNManager.load_content | def load_content(self, account_id, urls):
"""Prefetches one or more URLs to the CDN edge nodes.
:param int account_id: the CDN account ID into which content should be
preloaded.
:param urls: a string or a list of strings representing the CDN URLs
that should be pre-loaded.
:returns: true if all load requests were successfully submitted;
otherwise, returns the first error encountered.
"""
if isinstance(urls, six.string_types):
urls = [urls]
for i in range(0, len(urls), MAX_URLS_PER_LOAD):
result = self.account.loadContent(urls[i:i + MAX_URLS_PER_LOAD],
id=account_id)
if not result:
return result
return True | python | def load_content(self, account_id, urls):
if isinstance(urls, six.string_types):
urls = [urls]
for i in range(0, len(urls), MAX_URLS_PER_LOAD):
result = self.account.loadContent(urls[i:i + MAX_URLS_PER_LOAD],
id=account_id)
if not result:
return result
return True | [
"def",
"load_content",
"(",
"self",
",",
"account_id",
",",
"urls",
")",
":",
"if",
"isinstance",
"(",
"urls",
",",
"six",
".",
"string_types",
")",
":",
"urls",
"=",
"[",
"urls",
"]",
"for",
"i",
"in",
"range",
"(",
"0",
",",
"len",
"(",
"urls",
")",
",",
"MAX_URLS_PER_LOAD",
")",
":",
"result",
"=",
"self",
".",
"account",
".",
"loadContent",
"(",
"urls",
"[",
"i",
":",
"i",
"+",
"MAX_URLS_PER_LOAD",
"]",
",",
"id",
"=",
"account_id",
")",
"if",
"not",
"result",
":",
"return",
"result",
"return",
"True"
]
| Prefetches one or more URLs to the CDN edge nodes.
:param int account_id: the CDN account ID into which content should be
preloaded.
:param urls: a string or a list of strings representing the CDN URLs
that should be pre-loaded.
:returns: true if all load requests were successfully submitted;
otherwise, returns the first error encountered. | [
"Prefetches",
"one",
"or",
"more",
"URLs",
"to",
"the",
"CDN",
"edge",
"nodes",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/cdn.py#L103-L123 |
softlayer/softlayer-python | SoftLayer/managers/cdn.py | CDNManager.purge_content | def purge_content(self, account_id, urls):
"""Purges one or more URLs from the CDN edge nodes.
:param int account_id: the CDN account ID from which content should
be purged.
:param urls: a string or a list of strings representing the CDN URLs
that should be purged.
:returns: a list of SoftLayer_Container_Network_ContentDelivery_PurgeService_Response objects
which indicates if the purge for each url was SUCCESS, FAILED or INVALID_URL.
"""
if isinstance(urls, six.string_types):
urls = [urls]
content_list = []
for i in range(0, len(urls), MAX_URLS_PER_PURGE):
content = self.account.purgeCache(urls[i:i + MAX_URLS_PER_PURGE], id=account_id)
content_list.extend(content)
return content_list | python | def purge_content(self, account_id, urls):
if isinstance(urls, six.string_types):
urls = [urls]
content_list = []
for i in range(0, len(urls), MAX_URLS_PER_PURGE):
content = self.account.purgeCache(urls[i:i + MAX_URLS_PER_PURGE], id=account_id)
content_list.extend(content)
return content_list | [
"def",
"purge_content",
"(",
"self",
",",
"account_id",
",",
"urls",
")",
":",
"if",
"isinstance",
"(",
"urls",
",",
"six",
".",
"string_types",
")",
":",
"urls",
"=",
"[",
"urls",
"]",
"content_list",
"=",
"[",
"]",
"for",
"i",
"in",
"range",
"(",
"0",
",",
"len",
"(",
"urls",
")",
",",
"MAX_URLS_PER_PURGE",
")",
":",
"content",
"=",
"self",
".",
"account",
".",
"purgeCache",
"(",
"urls",
"[",
"i",
":",
"i",
"+",
"MAX_URLS_PER_PURGE",
"]",
",",
"id",
"=",
"account_id",
")",
"content_list",
".",
"extend",
"(",
"content",
")",
"return",
"content_list"
]
| Purges one or more URLs from the CDN edge nodes.
:param int account_id: the CDN account ID from which content should
be purged.
:param urls: a string or a list of strings representing the CDN URLs
that should be purged.
:returns: a list of SoftLayer_Container_Network_ContentDelivery_PurgeService_Response objects
which indicates if the purge for each url was SUCCESS, FAILED or INVALID_URL. | [
"Purges",
"one",
"or",
"more",
"URLs",
"from",
"the",
"CDN",
"edge",
"nodes",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/cdn.py#L125-L144 |
softlayer/softlayer-python | SoftLayer/managers/load_balancer.py | LoadBalancerManager.get_lb_pkgs | def get_lb_pkgs(self):
"""Retrieves the local load balancer packages.
:returns: A dictionary containing the load balancer packages
"""
_filter = {'items': {'description':
utils.query_filter('*Load Balancer*')}}
packages = self.prod_pkg.getItems(id=0, filter=_filter)
pkgs = []
for package in packages:
if not package['description'].startswith('Global'):
pkgs.append(package)
return pkgs | python | def get_lb_pkgs(self):
_filter = {'items': {'description':
utils.query_filter('*Load Balancer*')}}
packages = self.prod_pkg.getItems(id=0, filter=_filter)
pkgs = []
for package in packages:
if not package['description'].startswith('Global'):
pkgs.append(package)
return pkgs | [
"def",
"get_lb_pkgs",
"(",
"self",
")",
":",
"_filter",
"=",
"{",
"'items'",
":",
"{",
"'description'",
":",
"utils",
".",
"query_filter",
"(",
"'*Load Balancer*'",
")",
"}",
"}",
"packages",
"=",
"self",
".",
"prod_pkg",
".",
"getItems",
"(",
"id",
"=",
"0",
",",
"filter",
"=",
"_filter",
")",
"pkgs",
"=",
"[",
"]",
"for",
"package",
"in",
"packages",
":",
"if",
"not",
"package",
"[",
"'description'",
"]",
".",
"startswith",
"(",
"'Global'",
")",
":",
"pkgs",
".",
"append",
"(",
"package",
")",
"return",
"pkgs"
]
| Retrieves the local load balancer packages.
:returns: A dictionary containing the load balancer packages | [
"Retrieves",
"the",
"local",
"load",
"balancer",
"packages",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/load_balancer.py#L27-L41 |
softlayer/softlayer-python | SoftLayer/managers/load_balancer.py | LoadBalancerManager._get_location | def _get_location(self, datacenter_name):
"""Returns the location of the specified datacenter.
:param string datacenter_name: The datacenter to create
the loadbalancer in
:returns: the location id of the given datacenter
"""
datacenters = self.client['Location'].getDataCenters()
for datacenter in datacenters:
if datacenter['name'] == datacenter_name:
return datacenter['id']
return 'FIRST_AVAILABLE' | python | def _get_location(self, datacenter_name):
datacenters = self.client['Location'].getDataCenters()
for datacenter in datacenters:
if datacenter['name'] == datacenter_name:
return datacenter['id']
return 'FIRST_AVAILABLE' | [
"def",
"_get_location",
"(",
"self",
",",
"datacenter_name",
")",
":",
"datacenters",
"=",
"self",
".",
"client",
"[",
"'Location'",
"]",
".",
"getDataCenters",
"(",
")",
"for",
"datacenter",
"in",
"datacenters",
":",
"if",
"datacenter",
"[",
"'name'",
"]",
"==",
"datacenter_name",
":",
"return",
"datacenter",
"[",
"'id'",
"]",
"return",
"'FIRST_AVAILABLE'"
]
| Returns the location of the specified datacenter.
:param string datacenter_name: The datacenter to create
the loadbalancer in
:returns: the location id of the given datacenter | [
"Returns",
"the",
"location",
"of",
"the",
"specified",
"datacenter",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/load_balancer.py#L73-L86 |
softlayer/softlayer-python | SoftLayer/managers/load_balancer.py | LoadBalancerManager.cancel_lb | def cancel_lb(self, loadbal_id):
"""Cancels the specified load balancer.
:param int loadbal_id: Load Balancer ID to be cancelled.
"""
lb_billing = self.lb_svc.getBillingItem(id=loadbal_id)
billing_id = lb_billing['id']
billing_item = self.client['Billing_Item']
return billing_item.cancelService(id=billing_id) | python | def cancel_lb(self, loadbal_id):
lb_billing = self.lb_svc.getBillingItem(id=loadbal_id)
billing_id = lb_billing['id']
billing_item = self.client['Billing_Item']
return billing_item.cancelService(id=billing_id) | [
"def",
"cancel_lb",
"(",
"self",
",",
"loadbal_id",
")",
":",
"lb_billing",
"=",
"self",
".",
"lb_svc",
".",
"getBillingItem",
"(",
"id",
"=",
"loadbal_id",
")",
"billing_id",
"=",
"lb_billing",
"[",
"'id'",
"]",
"billing_item",
"=",
"self",
".",
"client",
"[",
"'Billing_Item'",
"]",
"return",
"billing_item",
".",
"cancelService",
"(",
"id",
"=",
"billing_id",
")"
]
| Cancels the specified load balancer.
:param int loadbal_id: Load Balancer ID to be cancelled. | [
"Cancels",
"the",
"specified",
"load",
"balancer",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/load_balancer.py#L88-L97 |
softlayer/softlayer-python | SoftLayer/managers/load_balancer.py | LoadBalancerManager.add_local_lb | def add_local_lb(self, price_item_id, datacenter):
"""Creates a local load balancer in the specified data center.
:param int price_item_id: The price item ID for the load balancer
:param string datacenter: The datacenter to create the loadbalancer in
:returns: A dictionary containing the product order
"""
product_order = {
'complexType': 'SoftLayer_Container_Product_Order_Network_'
'LoadBalancer',
'quantity': 1,
'packageId': 0,
"location": self._get_location(datacenter),
'prices': [{'id': price_item_id}]
}
return self.client['Product_Order'].placeOrder(product_order) | python | def add_local_lb(self, price_item_id, datacenter):
product_order = {
'complexType': 'SoftLayer_Container_Product_Order_Network_'
'LoadBalancer',
'quantity': 1,
'packageId': 0,
"location": self._get_location(datacenter),
'prices': [{'id': price_item_id}]
}
return self.client['Product_Order'].placeOrder(product_order) | [
"def",
"add_local_lb",
"(",
"self",
",",
"price_item_id",
",",
"datacenter",
")",
":",
"product_order",
"=",
"{",
"'complexType'",
":",
"'SoftLayer_Container_Product_Order_Network_'",
"'LoadBalancer'",
",",
"'quantity'",
":",
"1",
",",
"'packageId'",
":",
"0",
",",
"\"location\"",
":",
"self",
".",
"_get_location",
"(",
"datacenter",
")",
",",
"'prices'",
":",
"[",
"{",
"'id'",
":",
"price_item_id",
"}",
"]",
"}",
"return",
"self",
".",
"client",
"[",
"'Product_Order'",
"]",
".",
"placeOrder",
"(",
"product_order",
")"
]
| Creates a local load balancer in the specified data center.
:param int price_item_id: The price item ID for the load balancer
:param string datacenter: The datacenter to create the loadbalancer in
:returns: A dictionary containing the product order | [
"Creates",
"a",
"local",
"load",
"balancer",
"in",
"the",
"specified",
"data",
"center",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/load_balancer.py#L99-L115 |
softlayer/softlayer-python | SoftLayer/managers/load_balancer.py | LoadBalancerManager.get_local_lb | def get_local_lb(self, loadbal_id, **kwargs):
"""Returns a specified local load balancer given the id.
:param int loadbal_id: The id of the load balancer to retrieve
:returns: A dictionary containing the details of the load balancer
"""
if 'mask' not in kwargs:
kwargs['mask'] = ('loadBalancerHardware[datacenter], '
'ipAddress, virtualServers[serviceGroups'
'[routingMethod,routingType,services'
'[healthChecks[type], groupReferences,'
' ipAddress]]]')
return self.lb_svc.getObject(id=loadbal_id, **kwargs) | python | def get_local_lb(self, loadbal_id, **kwargs):
if 'mask' not in kwargs:
kwargs['mask'] = ('loadBalancerHardware[datacenter], '
'ipAddress, virtualServers[serviceGroups'
'[routingMethod,routingType,services'
'[healthChecks[type], groupReferences,'
' ipAddress]]]')
return self.lb_svc.getObject(id=loadbal_id, **kwargs) | [
"def",
"get_local_lb",
"(",
"self",
",",
"loadbal_id",
",",
"*",
"*",
"kwargs",
")",
":",
"if",
"'mask'",
"not",
"in",
"kwargs",
":",
"kwargs",
"[",
"'mask'",
"]",
"=",
"(",
"'loadBalancerHardware[datacenter], '",
"'ipAddress, virtualServers[serviceGroups'",
"'[routingMethod,routingType,services'",
"'[healthChecks[type], groupReferences,'",
"' ipAddress]]]'",
")",
"return",
"self",
".",
"lb_svc",
".",
"getObject",
"(",
"id",
"=",
"loadbal_id",
",",
"*",
"*",
"kwargs",
")"
]
| Returns a specified local load balancer given the id.
:param int loadbal_id: The id of the load balancer to retrieve
:returns: A dictionary containing the details of the load balancer | [
"Returns",
"a",
"specified",
"local",
"load",
"balancer",
"given",
"the",
"id",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/load_balancer.py#L126-L140 |
softlayer/softlayer-python | SoftLayer/managers/load_balancer.py | LoadBalancerManager.delete_service | def delete_service(self, service_id):
"""Deletes a service from the loadbal_id.
:param int service_id: The id of the service to delete
"""
svc = self.client['Network_Application_Delivery_Controller_'
'LoadBalancer_Service']
return svc.deleteObject(id=service_id) | python | def delete_service(self, service_id):
svc = self.client['Network_Application_Delivery_Controller_'
'LoadBalancer_Service']
return svc.deleteObject(id=service_id) | [
"def",
"delete_service",
"(",
"self",
",",
"service_id",
")",
":",
"svc",
"=",
"self",
".",
"client",
"[",
"'Network_Application_Delivery_Controller_'",
"'LoadBalancer_Service'",
"]",
"return",
"svc",
".",
"deleteObject",
"(",
"id",
"=",
"service_id",
")"
]
| Deletes a service from the loadbal_id.
:param int service_id: The id of the service to delete | [
"Deletes",
"a",
"service",
"from",
"the",
"loadbal_id",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/load_balancer.py#L142-L151 |
softlayer/softlayer-python | SoftLayer/managers/load_balancer.py | LoadBalancerManager.delete_service_group | def delete_service_group(self, group_id):
"""Deletes a service group from the loadbal_id.
:param int group_id: The id of the service group to delete
"""
svc = self.client['Network_Application_Delivery_Controller_'
'LoadBalancer_VirtualServer']
return svc.deleteObject(id=group_id) | python | def delete_service_group(self, group_id):
svc = self.client['Network_Application_Delivery_Controller_'
'LoadBalancer_VirtualServer']
return svc.deleteObject(id=group_id) | [
"def",
"delete_service_group",
"(",
"self",
",",
"group_id",
")",
":",
"svc",
"=",
"self",
".",
"client",
"[",
"'Network_Application_Delivery_Controller_'",
"'LoadBalancer_VirtualServer'",
"]",
"return",
"svc",
".",
"deleteObject",
"(",
"id",
"=",
"group_id",
")"
]
| Deletes a service group from the loadbal_id.
:param int group_id: The id of the service group to delete | [
"Deletes",
"a",
"service",
"group",
"from",
"the",
"loadbal_id",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/load_balancer.py#L153-L162 |
softlayer/softlayer-python | SoftLayer/managers/load_balancer.py | LoadBalancerManager.toggle_service_status | def toggle_service_status(self, service_id):
"""Toggles the service status.
:param int service_id: The id of the service to delete
"""
svc = self.client['Network_Application_Delivery_Controller_'
'LoadBalancer_Service']
return svc.toggleStatus(id=service_id) | python | def toggle_service_status(self, service_id):
svc = self.client['Network_Application_Delivery_Controller_'
'LoadBalancer_Service']
return svc.toggleStatus(id=service_id) | [
"def",
"toggle_service_status",
"(",
"self",
",",
"service_id",
")",
":",
"svc",
"=",
"self",
".",
"client",
"[",
"'Network_Application_Delivery_Controller_'",
"'LoadBalancer_Service'",
"]",
"return",
"svc",
".",
"toggleStatus",
"(",
"id",
"=",
"service_id",
")"
]
| Toggles the service status.
:param int service_id: The id of the service to delete | [
"Toggles",
"the",
"service",
"status",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/load_balancer.py#L164-L172 |
softlayer/softlayer-python | SoftLayer/managers/load_balancer.py | LoadBalancerManager.edit_service | def edit_service(self, loadbal_id, service_id, ip_address_id=None,
port=None, enabled=None, hc_type=None, weight=None):
"""Edits an existing service properties.
:param int loadbal_id: The id of the loadbal where the service resides
:param int service_id: The id of the service to edit
:param string ip_address: The ip address of the service
:param int port: the port of the service
:param bool enabled: enable or disable the search
:param int hc_type: The health check type
:param int weight: the weight to give to the service
"""
_filter = {
'virtualServers': {
'serviceGroups': {
'services': {'id': utils.query_filter(service_id)}}}}
mask = 'serviceGroups[services[groupReferences,healthChecks]]'
virtual_servers = self.lb_svc.getVirtualServers(id=loadbal_id,
filter=_filter,
mask=mask)
for service in virtual_servers[0]['serviceGroups'][0]['services']:
if service['id'] == service_id:
if enabled is not None:
service['enabled'] = int(enabled)
if port is not None:
service['port'] = port
if weight is not None:
service['groupReferences'][0]['weight'] = weight
if hc_type is not None:
service['healthChecks'][0]['healthCheckTypeId'] = hc_type
if ip_address_id is not None:
service['ipAddressId'] = ip_address_id
template = {'virtualServers': list(virtual_servers)}
load_balancer = self.lb_svc.editObject(template, id=loadbal_id)
return load_balancer | python | def edit_service(self, loadbal_id, service_id, ip_address_id=None,
port=None, enabled=None, hc_type=None, weight=None):
_filter = {
'virtualServers': {
'serviceGroups': {
'services': {'id': utils.query_filter(service_id)}}}}
mask = 'serviceGroups[services[groupReferences,healthChecks]]'
virtual_servers = self.lb_svc.getVirtualServers(id=loadbal_id,
filter=_filter,
mask=mask)
for service in virtual_servers[0]['serviceGroups'][0]['services']:
if service['id'] == service_id:
if enabled is not None:
service['enabled'] = int(enabled)
if port is not None:
service['port'] = port
if weight is not None:
service['groupReferences'][0]['weight'] = weight
if hc_type is not None:
service['healthChecks'][0]['healthCheckTypeId'] = hc_type
if ip_address_id is not None:
service['ipAddressId'] = ip_address_id
template = {'virtualServers': list(virtual_servers)}
load_balancer = self.lb_svc.editObject(template, id=loadbal_id)
return load_balancer | [
"def",
"edit_service",
"(",
"self",
",",
"loadbal_id",
",",
"service_id",
",",
"ip_address_id",
"=",
"None",
",",
"port",
"=",
"None",
",",
"enabled",
"=",
"None",
",",
"hc_type",
"=",
"None",
",",
"weight",
"=",
"None",
")",
":",
"_filter",
"=",
"{",
"'virtualServers'",
":",
"{",
"'serviceGroups'",
":",
"{",
"'services'",
":",
"{",
"'id'",
":",
"utils",
".",
"query_filter",
"(",
"service_id",
")",
"}",
"}",
"}",
"}",
"mask",
"=",
"'serviceGroups[services[groupReferences,healthChecks]]'",
"virtual_servers",
"=",
"self",
".",
"lb_svc",
".",
"getVirtualServers",
"(",
"id",
"=",
"loadbal_id",
",",
"filter",
"=",
"_filter",
",",
"mask",
"=",
"mask",
")",
"for",
"service",
"in",
"virtual_servers",
"[",
"0",
"]",
"[",
"'serviceGroups'",
"]",
"[",
"0",
"]",
"[",
"'services'",
"]",
":",
"if",
"service",
"[",
"'id'",
"]",
"==",
"service_id",
":",
"if",
"enabled",
"is",
"not",
"None",
":",
"service",
"[",
"'enabled'",
"]",
"=",
"int",
"(",
"enabled",
")",
"if",
"port",
"is",
"not",
"None",
":",
"service",
"[",
"'port'",
"]",
"=",
"port",
"if",
"weight",
"is",
"not",
"None",
":",
"service",
"[",
"'groupReferences'",
"]",
"[",
"0",
"]",
"[",
"'weight'",
"]",
"=",
"weight",
"if",
"hc_type",
"is",
"not",
"None",
":",
"service",
"[",
"'healthChecks'",
"]",
"[",
"0",
"]",
"[",
"'healthCheckTypeId'",
"]",
"=",
"hc_type",
"if",
"ip_address_id",
"is",
"not",
"None",
":",
"service",
"[",
"'ipAddressId'",
"]",
"=",
"ip_address_id",
"template",
"=",
"{",
"'virtualServers'",
":",
"list",
"(",
"virtual_servers",
")",
"}",
"load_balancer",
"=",
"self",
".",
"lb_svc",
".",
"editObject",
"(",
"template",
",",
"id",
"=",
"loadbal_id",
")",
"return",
"load_balancer"
]
| Edits an existing service properties.
:param int loadbal_id: The id of the loadbal where the service resides
:param int service_id: The id of the service to edit
:param string ip_address: The ip address of the service
:param int port: the port of the service
:param bool enabled: enable or disable the search
:param int hc_type: The health check type
:param int weight: the weight to give to the service | [
"Edits",
"an",
"existing",
"service",
"properties",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/load_balancer.py#L174-L214 |
softlayer/softlayer-python | SoftLayer/managers/load_balancer.py | LoadBalancerManager.add_service | def add_service(self, loadbal_id, service_group_id, ip_address_id,
port=80, enabled=True, hc_type=21, weight=1):
"""Adds a new service to the service group.
:param int loadbal_id: The id of the loadbal where the service resides
:param int service_group_id: The group to add the service to
:param int ip_address id: The ip address ID of the service
:param int port: the port of the service
:param bool enabled: Enable or disable the service
:param int hc_type: The health check type
:param int weight: the weight to give to the service
"""
kwargs = utils.NestedDict({})
kwargs['mask'] = ('virtualServers['
'serviceGroups[services[groupReferences]]]')
load_balancer = self.lb_svc.getObject(id=loadbal_id, **kwargs)
virtual_servers = load_balancer['virtualServers']
for virtual_server in virtual_servers:
if virtual_server['id'] == service_group_id:
service_template = {
'enabled': int(enabled),
'port': port,
'ipAddressId': ip_address_id,
'healthChecks': [
{
'healthCheckTypeId': hc_type
}
],
'groupReferences': [
{
'weight': weight
}
]
}
services = virtual_server['serviceGroups'][0]['services']
services.append(service_template)
return self.lb_svc.editObject(load_balancer, id=loadbal_id) | python | def add_service(self, loadbal_id, service_group_id, ip_address_id,
port=80, enabled=True, hc_type=21, weight=1):
kwargs = utils.NestedDict({})
kwargs['mask'] = ('virtualServers['
'serviceGroups[services[groupReferences]]]')
load_balancer = self.lb_svc.getObject(id=loadbal_id, **kwargs)
virtual_servers = load_balancer['virtualServers']
for virtual_server in virtual_servers:
if virtual_server['id'] == service_group_id:
service_template = {
'enabled': int(enabled),
'port': port,
'ipAddressId': ip_address_id,
'healthChecks': [
{
'healthCheckTypeId': hc_type
}
],
'groupReferences': [
{
'weight': weight
}
]
}
services = virtual_server['serviceGroups'][0]['services']
services.append(service_template)
return self.lb_svc.editObject(load_balancer, id=loadbal_id) | [
"def",
"add_service",
"(",
"self",
",",
"loadbal_id",
",",
"service_group_id",
",",
"ip_address_id",
",",
"port",
"=",
"80",
",",
"enabled",
"=",
"True",
",",
"hc_type",
"=",
"21",
",",
"weight",
"=",
"1",
")",
":",
"kwargs",
"=",
"utils",
".",
"NestedDict",
"(",
"{",
"}",
")",
"kwargs",
"[",
"'mask'",
"]",
"=",
"(",
"'virtualServers['",
"'serviceGroups[services[groupReferences]]]'",
")",
"load_balancer",
"=",
"self",
".",
"lb_svc",
".",
"getObject",
"(",
"id",
"=",
"loadbal_id",
",",
"*",
"*",
"kwargs",
")",
"virtual_servers",
"=",
"load_balancer",
"[",
"'virtualServers'",
"]",
"for",
"virtual_server",
"in",
"virtual_servers",
":",
"if",
"virtual_server",
"[",
"'id'",
"]",
"==",
"service_group_id",
":",
"service_template",
"=",
"{",
"'enabled'",
":",
"int",
"(",
"enabled",
")",
",",
"'port'",
":",
"port",
",",
"'ipAddressId'",
":",
"ip_address_id",
",",
"'healthChecks'",
":",
"[",
"{",
"'healthCheckTypeId'",
":",
"hc_type",
"}",
"]",
",",
"'groupReferences'",
":",
"[",
"{",
"'weight'",
":",
"weight",
"}",
"]",
"}",
"services",
"=",
"virtual_server",
"[",
"'serviceGroups'",
"]",
"[",
"0",
"]",
"[",
"'services'",
"]",
"services",
".",
"append",
"(",
"service_template",
")",
"return",
"self",
".",
"lb_svc",
".",
"editObject",
"(",
"load_balancer",
",",
"id",
"=",
"loadbal_id",
")"
]
| Adds a new service to the service group.
:param int loadbal_id: The id of the loadbal where the service resides
:param int service_group_id: The group to add the service to
:param int ip_address id: The ip address ID of the service
:param int port: the port of the service
:param bool enabled: Enable or disable the service
:param int hc_type: The health check type
:param int weight: the weight to give to the service | [
"Adds",
"a",
"new",
"service",
"to",
"the",
"service",
"group",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/load_balancer.py#L216-L254 |
softlayer/softlayer-python | SoftLayer/managers/load_balancer.py | LoadBalancerManager.add_service_group | def add_service_group(self, lb_id, allocation=100, port=80,
routing_type=2, routing_method=10):
"""Adds a new service group to the load balancer.
:param int loadbal_id: The id of the loadbal where the service resides
:param int allocation: percent of connections to allocate toward the
group
:param int port: the port of the service group
:param int routing_type: the routing type to set on the service group
:param int routing_method: The routing method to set on the group
"""
mask = 'virtualServers[serviceGroups[services[groupReferences]]]'
load_balancer = self.lb_svc.getObject(id=lb_id, mask=mask)
service_template = {
'port': port,
'allocation': allocation,
'serviceGroups': [
{
'routingTypeId': routing_type,
'routingMethodId': routing_method
}
]
}
load_balancer['virtualServers'].append(service_template)
return self.lb_svc.editObject(load_balancer, id=lb_id) | python | def add_service_group(self, lb_id, allocation=100, port=80,
routing_type=2, routing_method=10):
mask = 'virtualServers[serviceGroups[services[groupReferences]]]'
load_balancer = self.lb_svc.getObject(id=lb_id, mask=mask)
service_template = {
'port': port,
'allocation': allocation,
'serviceGroups': [
{
'routingTypeId': routing_type,
'routingMethodId': routing_method
}
]
}
load_balancer['virtualServers'].append(service_template)
return self.lb_svc.editObject(load_balancer, id=lb_id) | [
"def",
"add_service_group",
"(",
"self",
",",
"lb_id",
",",
"allocation",
"=",
"100",
",",
"port",
"=",
"80",
",",
"routing_type",
"=",
"2",
",",
"routing_method",
"=",
"10",
")",
":",
"mask",
"=",
"'virtualServers[serviceGroups[services[groupReferences]]]'",
"load_balancer",
"=",
"self",
".",
"lb_svc",
".",
"getObject",
"(",
"id",
"=",
"lb_id",
",",
"mask",
"=",
"mask",
")",
"service_template",
"=",
"{",
"'port'",
":",
"port",
",",
"'allocation'",
":",
"allocation",
",",
"'serviceGroups'",
":",
"[",
"{",
"'routingTypeId'",
":",
"routing_type",
",",
"'routingMethodId'",
":",
"routing_method",
"}",
"]",
"}",
"load_balancer",
"[",
"'virtualServers'",
"]",
".",
"append",
"(",
"service_template",
")",
"return",
"self",
".",
"lb_svc",
".",
"editObject",
"(",
"load_balancer",
",",
"id",
"=",
"lb_id",
")"
]
| Adds a new service group to the load balancer.
:param int loadbal_id: The id of the loadbal where the service resides
:param int allocation: percent of connections to allocate toward the
group
:param int port: the port of the service group
:param int routing_type: the routing type to set on the service group
:param int routing_method: The routing method to set on the group | [
"Adds",
"a",
"new",
"service",
"group",
"to",
"the",
"load",
"balancer",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/load_balancer.py#L256-L282 |
softlayer/softlayer-python | SoftLayer/managers/load_balancer.py | LoadBalancerManager.edit_service_group | def edit_service_group(self, loadbal_id, group_id, allocation=None,
port=None, routing_type=None, routing_method=None):
"""Edit an existing service group.
:param int loadbal_id: The id of the loadbal where the service resides
:param int group_id: The id of the service group
:param int allocation: the % of connections to allocate to the group
:param int port: the port of the service group
:param int routing_type: the routing type to set on the service group
:param int routing_method: The routing method to set on the group
"""
mask = 'virtualServers[serviceGroups[services[groupReferences]]]'
load_balancer = self.lb_svc.getObject(id=loadbal_id, mask=mask)
virtual_servers = load_balancer['virtualServers']
for virtual_server in virtual_servers:
if virtual_server['id'] == group_id:
service_group = virtual_server['serviceGroups'][0]
if allocation is not None:
virtual_server['allocation'] = allocation
if port is not None:
virtual_server['port'] = port
if routing_type is not None:
service_group['routingTypeId'] = routing_type
if routing_method is not None:
service_group['routingMethodId'] = routing_method
break
return self.lb_svc.editObject(load_balancer, id=loadbal_id) | python | def edit_service_group(self, loadbal_id, group_id, allocation=None,
port=None, routing_type=None, routing_method=None):
mask = 'virtualServers[serviceGroups[services[groupReferences]]]'
load_balancer = self.lb_svc.getObject(id=loadbal_id, mask=mask)
virtual_servers = load_balancer['virtualServers']
for virtual_server in virtual_servers:
if virtual_server['id'] == group_id:
service_group = virtual_server['serviceGroups'][0]
if allocation is not None:
virtual_server['allocation'] = allocation
if port is not None:
virtual_server['port'] = port
if routing_type is not None:
service_group['routingTypeId'] = routing_type
if routing_method is not None:
service_group['routingMethodId'] = routing_method
break
return self.lb_svc.editObject(load_balancer, id=loadbal_id) | [
"def",
"edit_service_group",
"(",
"self",
",",
"loadbal_id",
",",
"group_id",
",",
"allocation",
"=",
"None",
",",
"port",
"=",
"None",
",",
"routing_type",
"=",
"None",
",",
"routing_method",
"=",
"None",
")",
":",
"mask",
"=",
"'virtualServers[serviceGroups[services[groupReferences]]]'",
"load_balancer",
"=",
"self",
".",
"lb_svc",
".",
"getObject",
"(",
"id",
"=",
"loadbal_id",
",",
"mask",
"=",
"mask",
")",
"virtual_servers",
"=",
"load_balancer",
"[",
"'virtualServers'",
"]",
"for",
"virtual_server",
"in",
"virtual_servers",
":",
"if",
"virtual_server",
"[",
"'id'",
"]",
"==",
"group_id",
":",
"service_group",
"=",
"virtual_server",
"[",
"'serviceGroups'",
"]",
"[",
"0",
"]",
"if",
"allocation",
"is",
"not",
"None",
":",
"virtual_server",
"[",
"'allocation'",
"]",
"=",
"allocation",
"if",
"port",
"is",
"not",
"None",
":",
"virtual_server",
"[",
"'port'",
"]",
"=",
"port",
"if",
"routing_type",
"is",
"not",
"None",
":",
"service_group",
"[",
"'routingTypeId'",
"]",
"=",
"routing_type",
"if",
"routing_method",
"is",
"not",
"None",
":",
"service_group",
"[",
"'routingMethodId'",
"]",
"=",
"routing_method",
"break",
"return",
"self",
".",
"lb_svc",
".",
"editObject",
"(",
"load_balancer",
",",
"id",
"=",
"loadbal_id",
")"
]
| Edit an existing service group.
:param int loadbal_id: The id of the loadbal where the service resides
:param int group_id: The id of the service group
:param int allocation: the % of connections to allocate to the group
:param int port: the port of the service group
:param int routing_type: the routing type to set on the service group
:param int routing_method: The routing method to set on the group | [
"Edit",
"an",
"existing",
"service",
"group",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/load_balancer.py#L284-L314 |
softlayer/softlayer-python | SoftLayer/managers/load_balancer.py | LoadBalancerManager.reset_service_group | def reset_service_group(self, loadbal_id, group_id):
"""Resets all the connections on the service group.
:param int loadbal_id: The id of the loadbal
:param int group_id: The id of the service group to reset
"""
_filter = {'virtualServers': {'id': utils.query_filter(group_id)}}
virtual_servers = self.lb_svc.getVirtualServers(id=loadbal_id,
filter=_filter,
mask='serviceGroups')
actual_id = virtual_servers[0]['serviceGroups'][0]['id']
svc = self.client['Network_Application_Delivery_Controller'
'_LoadBalancer_Service_Group']
return svc.kickAllConnections(id=actual_id) | python | def reset_service_group(self, loadbal_id, group_id):
_filter = {'virtualServers': {'id': utils.query_filter(group_id)}}
virtual_servers = self.lb_svc.getVirtualServers(id=loadbal_id,
filter=_filter,
mask='serviceGroups')
actual_id = virtual_servers[0]['serviceGroups'][0]['id']
svc = self.client['Network_Application_Delivery_Controller'
'_LoadBalancer_Service_Group']
return svc.kickAllConnections(id=actual_id) | [
"def",
"reset_service_group",
"(",
"self",
",",
"loadbal_id",
",",
"group_id",
")",
":",
"_filter",
"=",
"{",
"'virtualServers'",
":",
"{",
"'id'",
":",
"utils",
".",
"query_filter",
"(",
"group_id",
")",
"}",
"}",
"virtual_servers",
"=",
"self",
".",
"lb_svc",
".",
"getVirtualServers",
"(",
"id",
"=",
"loadbal_id",
",",
"filter",
"=",
"_filter",
",",
"mask",
"=",
"'serviceGroups'",
")",
"actual_id",
"=",
"virtual_servers",
"[",
"0",
"]",
"[",
"'serviceGroups'",
"]",
"[",
"0",
"]",
"[",
"'id'",
"]",
"svc",
"=",
"self",
".",
"client",
"[",
"'Network_Application_Delivery_Controller'",
"'_LoadBalancer_Service_Group'",
"]",
"return",
"svc",
".",
"kickAllConnections",
"(",
"id",
"=",
"actual_id",
")"
]
| Resets all the connections on the service group.
:param int loadbal_id: The id of the loadbal
:param int group_id: The id of the service group to reset | [
"Resets",
"all",
"the",
"connections",
"on",
"the",
"service",
"group",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/load_balancer.py#L316-L331 |
softlayer/softlayer-python | SoftLayer/CLI/image/detail.py | cli | def cli(env, identifier):
"""Get details for an image."""
image_mgr = SoftLayer.ImageManager(env.client)
image_id = helpers.resolve_id(image_mgr.resolve_ids, identifier, 'image')
image = image_mgr.get_image(image_id, mask=image_mod.DETAIL_MASK)
disk_space = 0
datacenters = []
for child in image.get('children'):
disk_space = int(child.get('blockDevicesDiskSpaceTotal', 0))
if child.get('datacenter'):
datacenters.append(utils.lookup(child, 'datacenter', 'name'))
table = formatting.KeyValueTable(['name', 'value'])
table.align['name'] = 'r'
table.align['value'] = 'l'
table.add_row(['id', image['id']])
table.add_row(['global_identifier',
image.get('globalIdentifier', formatting.blank())])
table.add_row(['name', image['name'].strip()])
table.add_row(['status', formatting.FormattedItem(
utils.lookup(image, 'status', 'keyname'),
utils.lookup(image, 'status', 'name'),
)])
table.add_row([
'active_transaction',
formatting.transaction_status(image.get('transaction')),
])
table.add_row(['account', image.get('accountId', formatting.blank())])
table.add_row(['visibility',
image_mod.PUBLIC_TYPE if image['publicFlag']
else image_mod.PRIVATE_TYPE])
table.add_row(['type',
formatting.FormattedItem(
utils.lookup(image, 'imageType', 'keyName'),
utils.lookup(image, 'imageType', 'name'),
)])
table.add_row(['flex', image.get('flexImageFlag')])
table.add_row(['note', image.get('note')])
table.add_row(['created', image.get('createDate')])
table.add_row(['disk_space', formatting.b_to_gb(disk_space)])
table.add_row(['datacenters', formatting.listing(sorted(datacenters),
separator=',')])
env.fout(table) | python | def cli(env, identifier):
image_mgr = SoftLayer.ImageManager(env.client)
image_id = helpers.resolve_id(image_mgr.resolve_ids, identifier, 'image')
image = image_mgr.get_image(image_id, mask=image_mod.DETAIL_MASK)
disk_space = 0
datacenters = []
for child in image.get('children'):
disk_space = int(child.get('blockDevicesDiskSpaceTotal', 0))
if child.get('datacenter'):
datacenters.append(utils.lookup(child, 'datacenter', 'name'))
table = formatting.KeyValueTable(['name', 'value'])
table.align['name'] = 'r'
table.align['value'] = 'l'
table.add_row(['id', image['id']])
table.add_row(['global_identifier',
image.get('globalIdentifier', formatting.blank())])
table.add_row(['name', image['name'].strip()])
table.add_row(['status', formatting.FormattedItem(
utils.lookup(image, 'status', 'keyname'),
utils.lookup(image, 'status', 'name'),
)])
table.add_row([
'active_transaction',
formatting.transaction_status(image.get('transaction')),
])
table.add_row(['account', image.get('accountId', formatting.blank())])
table.add_row(['visibility',
image_mod.PUBLIC_TYPE if image['publicFlag']
else image_mod.PRIVATE_TYPE])
table.add_row(['type',
formatting.FormattedItem(
utils.lookup(image, 'imageType', 'keyName'),
utils.lookup(image, 'imageType', 'name'),
)])
table.add_row(['flex', image.get('flexImageFlag')])
table.add_row(['note', image.get('note')])
table.add_row(['created', image.get('createDate')])
table.add_row(['disk_space', formatting.b_to_gb(disk_space)])
table.add_row(['datacenters', formatting.listing(sorted(datacenters),
separator=',')])
env.fout(table) | [
"def",
"cli",
"(",
"env",
",",
"identifier",
")",
":",
"image_mgr",
"=",
"SoftLayer",
".",
"ImageManager",
"(",
"env",
".",
"client",
")",
"image_id",
"=",
"helpers",
".",
"resolve_id",
"(",
"image_mgr",
".",
"resolve_ids",
",",
"identifier",
",",
"'image'",
")",
"image",
"=",
"image_mgr",
".",
"get_image",
"(",
"image_id",
",",
"mask",
"=",
"image_mod",
".",
"DETAIL_MASK",
")",
"disk_space",
"=",
"0",
"datacenters",
"=",
"[",
"]",
"for",
"child",
"in",
"image",
".",
"get",
"(",
"'children'",
")",
":",
"disk_space",
"=",
"int",
"(",
"child",
".",
"get",
"(",
"'blockDevicesDiskSpaceTotal'",
",",
"0",
")",
")",
"if",
"child",
".",
"get",
"(",
"'datacenter'",
")",
":",
"datacenters",
".",
"append",
"(",
"utils",
".",
"lookup",
"(",
"child",
",",
"'datacenter'",
",",
"'name'",
")",
")",
"table",
"=",
"formatting",
".",
"KeyValueTable",
"(",
"[",
"'name'",
",",
"'value'",
"]",
")",
"table",
".",
"align",
"[",
"'name'",
"]",
"=",
"'r'",
"table",
".",
"align",
"[",
"'value'",
"]",
"=",
"'l'",
"table",
".",
"add_row",
"(",
"[",
"'id'",
",",
"image",
"[",
"'id'",
"]",
"]",
")",
"table",
".",
"add_row",
"(",
"[",
"'global_identifier'",
",",
"image",
".",
"get",
"(",
"'globalIdentifier'",
",",
"formatting",
".",
"blank",
"(",
")",
")",
"]",
")",
"table",
".",
"add_row",
"(",
"[",
"'name'",
",",
"image",
"[",
"'name'",
"]",
".",
"strip",
"(",
")",
"]",
")",
"table",
".",
"add_row",
"(",
"[",
"'status'",
",",
"formatting",
".",
"FormattedItem",
"(",
"utils",
".",
"lookup",
"(",
"image",
",",
"'status'",
",",
"'keyname'",
")",
",",
"utils",
".",
"lookup",
"(",
"image",
",",
"'status'",
",",
"'name'",
")",
",",
")",
"]",
")",
"table",
".",
"add_row",
"(",
"[",
"'active_transaction'",
",",
"formatting",
".",
"transaction_status",
"(",
"image",
".",
"get",
"(",
"'transaction'",
")",
")",
",",
"]",
")",
"table",
".",
"add_row",
"(",
"[",
"'account'",
",",
"image",
".",
"get",
"(",
"'accountId'",
",",
"formatting",
".",
"blank",
"(",
")",
")",
"]",
")",
"table",
".",
"add_row",
"(",
"[",
"'visibility'",
",",
"image_mod",
".",
"PUBLIC_TYPE",
"if",
"image",
"[",
"'publicFlag'",
"]",
"else",
"image_mod",
".",
"PRIVATE_TYPE",
"]",
")",
"table",
".",
"add_row",
"(",
"[",
"'type'",
",",
"formatting",
".",
"FormattedItem",
"(",
"utils",
".",
"lookup",
"(",
"image",
",",
"'imageType'",
",",
"'keyName'",
")",
",",
"utils",
".",
"lookup",
"(",
"image",
",",
"'imageType'",
",",
"'name'",
")",
",",
")",
"]",
")",
"table",
".",
"add_row",
"(",
"[",
"'flex'",
",",
"image",
".",
"get",
"(",
"'flexImageFlag'",
")",
"]",
")",
"table",
".",
"add_row",
"(",
"[",
"'note'",
",",
"image",
".",
"get",
"(",
"'note'",
")",
"]",
")",
"table",
".",
"add_row",
"(",
"[",
"'created'",
",",
"image",
".",
"get",
"(",
"'createDate'",
")",
"]",
")",
"table",
".",
"add_row",
"(",
"[",
"'disk_space'",
",",
"formatting",
".",
"b_to_gb",
"(",
"disk_space",
")",
"]",
")",
"table",
".",
"add_row",
"(",
"[",
"'datacenters'",
",",
"formatting",
".",
"listing",
"(",
"sorted",
"(",
"datacenters",
")",
",",
"separator",
"=",
"','",
")",
"]",
")",
"env",
".",
"fout",
"(",
"table",
")"
]
| Get details for an image. | [
"Get",
"details",
"for",
"an",
"image",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/CLI/image/detail.py#L17-L63 |
softlayer/softlayer-python | SoftLayer/CLI/file/snapshot/enable.py | cli | def cli(env, volume_id, schedule_type, retention_count,
minute, hour, day_of_week):
"""Enables snapshots for a given volume on the specified schedule"""
file_manager = SoftLayer.FileStorageManager(env.client)
valid_schedule_types = {'INTERVAL', 'HOURLY', 'DAILY', 'WEEKLY'}
valid_days = {'SUNDAY', 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY',
'FRIDAY', 'SATURDAY'}
if schedule_type not in valid_schedule_types:
raise exceptions.CLIAbort(
'--schedule-type must be INTERVAL, HOURLY, ' +
'DAILY, or WEEKLY, not ' + schedule_type)
if schedule_type == 'INTERVAL' and (minute < 30 or minute > 59):
raise exceptions.CLIAbort(
'--minute value must be between 30 and 59')
if minute < 0 or minute > 59:
raise exceptions.CLIAbort(
'--minute value must be between 0 and 59')
if hour < 0 or hour > 23:
raise exceptions.CLIAbort(
'--hour value must be between 0 and 23')
if day_of_week not in valid_days:
raise exceptions.CLIAbort(
'--day_of_week value must be a valid day (ex: SUNDAY)')
enabled = file_manager.enable_snapshots(volume_id, schedule_type,
retention_count, minute,
hour, day_of_week)
if enabled:
click.echo('%s snapshots have been enabled for volume %s'
% (schedule_type, volume_id)) | python | def cli(env, volume_id, schedule_type, retention_count,
minute, hour, day_of_week):
file_manager = SoftLayer.FileStorageManager(env.client)
valid_schedule_types = {'INTERVAL', 'HOURLY', 'DAILY', 'WEEKLY'}
valid_days = {'SUNDAY', 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY',
'FRIDAY', 'SATURDAY'}
if schedule_type not in valid_schedule_types:
raise exceptions.CLIAbort(
'--schedule-type must be INTERVAL, HOURLY, ' +
'DAILY, or WEEKLY, not ' + schedule_type)
if schedule_type == 'INTERVAL' and (minute < 30 or minute > 59):
raise exceptions.CLIAbort(
'--minute value must be between 30 and 59')
if minute < 0 or minute > 59:
raise exceptions.CLIAbort(
'--minute value must be between 0 and 59')
if hour < 0 or hour > 23:
raise exceptions.CLIAbort(
'--hour value must be between 0 and 23')
if day_of_week not in valid_days:
raise exceptions.CLIAbort(
'--day_of_week value must be a valid day (ex: SUNDAY)')
enabled = file_manager.enable_snapshots(volume_id, schedule_type,
retention_count, minute,
hour, day_of_week)
if enabled:
click.echo('%s snapshots have been enabled for volume %s'
% (schedule_type, volume_id)) | [
"def",
"cli",
"(",
"env",
",",
"volume_id",
",",
"schedule_type",
",",
"retention_count",
",",
"minute",
",",
"hour",
",",
"day_of_week",
")",
":",
"file_manager",
"=",
"SoftLayer",
".",
"FileStorageManager",
"(",
"env",
".",
"client",
")",
"valid_schedule_types",
"=",
"{",
"'INTERVAL'",
",",
"'HOURLY'",
",",
"'DAILY'",
",",
"'WEEKLY'",
"}",
"valid_days",
"=",
"{",
"'SUNDAY'",
",",
"'MONDAY'",
",",
"'TUESDAY'",
",",
"'WEDNESDAY'",
",",
"'THURSDAY'",
",",
"'FRIDAY'",
",",
"'SATURDAY'",
"}",
"if",
"schedule_type",
"not",
"in",
"valid_schedule_types",
":",
"raise",
"exceptions",
".",
"CLIAbort",
"(",
"'--schedule-type must be INTERVAL, HOURLY, '",
"+",
"'DAILY, or WEEKLY, not '",
"+",
"schedule_type",
")",
"if",
"schedule_type",
"==",
"'INTERVAL'",
"and",
"(",
"minute",
"<",
"30",
"or",
"minute",
">",
"59",
")",
":",
"raise",
"exceptions",
".",
"CLIAbort",
"(",
"'--minute value must be between 30 and 59'",
")",
"if",
"minute",
"<",
"0",
"or",
"minute",
">",
"59",
":",
"raise",
"exceptions",
".",
"CLIAbort",
"(",
"'--minute value must be between 0 and 59'",
")",
"if",
"hour",
"<",
"0",
"or",
"hour",
">",
"23",
":",
"raise",
"exceptions",
".",
"CLIAbort",
"(",
"'--hour value must be between 0 and 23'",
")",
"if",
"day_of_week",
"not",
"in",
"valid_days",
":",
"raise",
"exceptions",
".",
"CLIAbort",
"(",
"'--day_of_week value must be a valid day (ex: SUNDAY)'",
")",
"enabled",
"=",
"file_manager",
".",
"enable_snapshots",
"(",
"volume_id",
",",
"schedule_type",
",",
"retention_count",
",",
"minute",
",",
"hour",
",",
"day_of_week",
")",
"if",
"enabled",
":",
"click",
".",
"echo",
"(",
"'%s snapshots have been enabled for volume %s'",
"%",
"(",
"schedule_type",
",",
"volume_id",
")",
")"
]
| Enables snapshots for a given volume on the specified schedule | [
"Enables",
"snapshots",
"for",
"a",
"given",
"volume",
"on",
"the",
"specified",
"schedule"
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/CLI/file/snapshot/enable.py#L28-L61 |
softlayer/softlayer-python | SoftLayer/managers/account.py | AccountManager.get_upcoming_events | def get_upcoming_events(self):
"""Retreives a list of Notification_Occurrence_Events that have not ended yet
:return: SoftLayer_Notification_Occurrence_Event
"""
mask = "mask[id, subject, startDate, endDate, statusCode, acknowledgedFlag, impactedResourceCount, updateCount]"
_filter = {
'endDate': {
'operation': '> sysdate'
},
'startDate': {
'operation': 'orderBy',
'options': [{
'name': 'sort',
'value': ['ASC']
}]
}
}
return self.client.call('Notification_Occurrence_Event', 'getAllObjects', filter=_filter, mask=mask, iter=True) | python | def get_upcoming_events(self):
mask = "mask[id, subject, startDate, endDate, statusCode, acknowledgedFlag, impactedResourceCount, updateCount]"
_filter = {
'endDate': {
'operation': '> sysdate'
},
'startDate': {
'operation': 'orderBy',
'options': [{
'name': 'sort',
'value': ['ASC']
}]
}
}
return self.client.call('Notification_Occurrence_Event', 'getAllObjects', filter=_filter, mask=mask, iter=True) | [
"def",
"get_upcoming_events",
"(",
"self",
")",
":",
"mask",
"=",
"\"mask[id, subject, startDate, endDate, statusCode, acknowledgedFlag, impactedResourceCount, updateCount]\"",
"_filter",
"=",
"{",
"'endDate'",
":",
"{",
"'operation'",
":",
"'> sysdate'",
"}",
",",
"'startDate'",
":",
"{",
"'operation'",
":",
"'orderBy'",
",",
"'options'",
":",
"[",
"{",
"'name'",
":",
"'sort'",
",",
"'value'",
":",
"[",
"'ASC'",
"]",
"}",
"]",
"}",
"}",
"return",
"self",
".",
"client",
".",
"call",
"(",
"'Notification_Occurrence_Event'",
",",
"'getAllObjects'",
",",
"filter",
"=",
"_filter",
",",
"mask",
"=",
"mask",
",",
"iter",
"=",
"True",
")"
]
| Retreives a list of Notification_Occurrence_Events that have not ended yet
:return: SoftLayer_Notification_Occurrence_Event | [
"Retreives",
"a",
"list",
"of",
"Notification_Occurrence_Events",
"that",
"have",
"not",
"ended",
"yet"
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/account.py#L50-L68 |
softlayer/softlayer-python | SoftLayer/managers/account.py | AccountManager.get_event | def get_event(self, event_id):
"""Gets details about a maintenance event
:param int event_id: Notification_Occurrence_Event ID
:return: Notification_Occurrence_Event
"""
mask = """mask[
acknowledgedFlag,
attachments,
impactedResources,
statusCode,
updates,
notificationOccurrenceEventType]
"""
return self.client.call('Notification_Occurrence_Event', 'getObject', id=event_id, mask=mask) | python | def get_event(self, event_id):
mask =
return self.client.call('Notification_Occurrence_Event', 'getObject', id=event_id, mask=mask) | [
"def",
"get_event",
"(",
"self",
",",
"event_id",
")",
":",
"mask",
"=",
"\"\"\"mask[\n acknowledgedFlag,\n attachments,\n impactedResources,\n statusCode,\n updates,\n notificationOccurrenceEventType]\n \"\"\"",
"return",
"self",
".",
"client",
".",
"call",
"(",
"'Notification_Occurrence_Event'",
",",
"'getObject'",
",",
"id",
"=",
"event_id",
",",
"mask",
"=",
"mask",
")"
]
| Gets details about a maintenance event
:param int event_id: Notification_Occurrence_Event ID
:return: Notification_Occurrence_Event | [
"Gets",
"details",
"about",
"a",
"maintenance",
"event"
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/account.py#L78-L92 |
softlayer/softlayer-python | SoftLayer/managers/account.py | AccountManager.get_invoices | def get_invoices(self, limit=50, closed=False, get_all=False):
"""Gets an accounts invoices.
:param int limit: Number of invoices to get back in a single call.
:param bool closed: If True, will also get CLOSED invoices
:param bool get_all: If True, will paginate through invoices until all have been retrieved.
:return: Billing_Invoice
"""
mask = "mask[invoiceTotalAmount, itemCount]"
_filter = {
'invoices': {
'createDate': {
'operation': 'orderBy',
'options': [{
'name': 'sort',
'value': ['DESC']
}]
},
'statusCode': {'operation': 'OPEN'},
}
}
if closed:
del _filter['invoices']['statusCode']
return self.client.call('Account', 'getInvoices', mask=mask, filter=_filter, iter=get_all, limit=limit) | python | def get_invoices(self, limit=50, closed=False, get_all=False):
mask = "mask[invoiceTotalAmount, itemCount]"
_filter = {
'invoices': {
'createDate': {
'operation': 'orderBy',
'options': [{
'name': 'sort',
'value': ['DESC']
}]
},
'statusCode': {'operation': 'OPEN'},
}
}
if closed:
del _filter['invoices']['statusCode']
return self.client.call('Account', 'getInvoices', mask=mask, filter=_filter, iter=get_all, limit=limit) | [
"def",
"get_invoices",
"(",
"self",
",",
"limit",
"=",
"50",
",",
"closed",
"=",
"False",
",",
"get_all",
"=",
"False",
")",
":",
"mask",
"=",
"\"mask[invoiceTotalAmount, itemCount]\"",
"_filter",
"=",
"{",
"'invoices'",
":",
"{",
"'createDate'",
":",
"{",
"'operation'",
":",
"'orderBy'",
",",
"'options'",
":",
"[",
"{",
"'name'",
":",
"'sort'",
",",
"'value'",
":",
"[",
"'DESC'",
"]",
"}",
"]",
"}",
",",
"'statusCode'",
":",
"{",
"'operation'",
":",
"'OPEN'",
"}",
",",
"}",
"}",
"if",
"closed",
":",
"del",
"_filter",
"[",
"'invoices'",
"]",
"[",
"'statusCode'",
"]",
"return",
"self",
".",
"client",
".",
"call",
"(",
"'Account'",
",",
"'getInvoices'",
",",
"mask",
"=",
"mask",
",",
"filter",
"=",
"_filter",
",",
"iter",
"=",
"get_all",
",",
"limit",
"=",
"limit",
")"
]
| Gets an accounts invoices.
:param int limit: Number of invoices to get back in a single call.
:param bool closed: If True, will also get CLOSED invoices
:param bool get_all: If True, will paginate through invoices until all have been retrieved.
:return: Billing_Invoice | [
"Gets",
"an",
"accounts",
"invoices",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/account.py#L94-L118 |
softlayer/softlayer-python | SoftLayer/managers/account.py | AccountManager.get_billing_items | def get_billing_items(self, identifier):
"""Gets all topLevelBillingItems from a specific invoice
:param int identifier: Invoice Id
:return: Billing_Invoice_Item
"""
mask = """mask[
id, description, hostName, domainName, oneTimeAfterTaxAmount, recurringAfterTaxAmount, createDate,
categoryCode,
category[name],
location[name],
children[id, category[name], description, oneTimeAfterTaxAmount, recurringAfterTaxAmount]
]"""
return self.client.call(
'Billing_Invoice',
'getInvoiceTopLevelItems',
id=identifier,
mask=mask,
iter=True,
limit=100
) | python | def get_billing_items(self, identifier):
mask =
return self.client.call(
'Billing_Invoice',
'getInvoiceTopLevelItems',
id=identifier,
mask=mask,
iter=True,
limit=100
) | [
"def",
"get_billing_items",
"(",
"self",
",",
"identifier",
")",
":",
"mask",
"=",
"\"\"\"mask[\n id, description, hostName, domainName, oneTimeAfterTaxAmount, recurringAfterTaxAmount, createDate,\n categoryCode,\n category[name],\n location[name],\n children[id, category[name], description, oneTimeAfterTaxAmount, recurringAfterTaxAmount]\n ]\"\"\"",
"return",
"self",
".",
"client",
".",
"call",
"(",
"'Billing_Invoice'",
",",
"'getInvoiceTopLevelItems'",
",",
"id",
"=",
"identifier",
",",
"mask",
"=",
"mask",
",",
"iter",
"=",
"True",
",",
"limit",
"=",
"100",
")"
]
| Gets all topLevelBillingItems from a specific invoice
:param int identifier: Invoice Id
:return: Billing_Invoice_Item | [
"Gets",
"all",
"topLevelBillingItems",
"from",
"a",
"specific",
"invoice"
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/managers/account.py#L120-L141 |
softlayer/softlayer-python | SoftLayer/CLI/loadbal/create_options.py | cli | def cli(env):
"""Get price options to create a load balancer with."""
mgr = SoftLayer.LoadBalancerManager(env.client)
table = formatting.Table(['price_id', 'capacity', 'description', 'price'])
table.sortby = 'price'
table.align['price'] = 'r'
table.align['capacity'] = 'r'
table.align['id'] = 'r'
packages = mgr.get_lb_pkgs()
for package in packages:
table.add_row([
package['prices'][0]['id'],
package.get('capacity'),
package['description'],
'%.2f' % float(package['prices'][0]['recurringFee'])
])
env.fout(table) | python | def cli(env):
mgr = SoftLayer.LoadBalancerManager(env.client)
table = formatting.Table(['price_id', 'capacity', 'description', 'price'])
table.sortby = 'price'
table.align['price'] = 'r'
table.align['capacity'] = 'r'
table.align['id'] = 'r'
packages = mgr.get_lb_pkgs()
for package in packages:
table.add_row([
package['prices'][0]['id'],
package.get('capacity'),
package['description'],
'%.2f' % float(package['prices'][0]['recurringFee'])
])
env.fout(table) | [
"def",
"cli",
"(",
"env",
")",
":",
"mgr",
"=",
"SoftLayer",
".",
"LoadBalancerManager",
"(",
"env",
".",
"client",
")",
"table",
"=",
"formatting",
".",
"Table",
"(",
"[",
"'price_id'",
",",
"'capacity'",
",",
"'description'",
",",
"'price'",
"]",
")",
"table",
".",
"sortby",
"=",
"'price'",
"table",
".",
"align",
"[",
"'price'",
"]",
"=",
"'r'",
"table",
".",
"align",
"[",
"'capacity'",
"]",
"=",
"'r'",
"table",
".",
"align",
"[",
"'id'",
"]",
"=",
"'r'",
"packages",
"=",
"mgr",
".",
"get_lb_pkgs",
"(",
")",
"for",
"package",
"in",
"packages",
":",
"table",
".",
"add_row",
"(",
"[",
"package",
"[",
"'prices'",
"]",
"[",
"0",
"]",
"[",
"'id'",
"]",
",",
"package",
".",
"get",
"(",
"'capacity'",
")",
",",
"package",
"[",
"'description'",
"]",
",",
"'%.2f'",
"%",
"float",
"(",
"package",
"[",
"'prices'",
"]",
"[",
"0",
"]",
"[",
"'recurringFee'",
"]",
")",
"]",
")",
"env",
".",
"fout",
"(",
"table",
")"
]
| Get price options to create a load balancer with. | [
"Get",
"price",
"options",
"to",
"create",
"a",
"load",
"balancer",
"with",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/CLI/loadbal/create_options.py#L13-L35 |
softlayer/softlayer-python | SoftLayer/CLI/virt/credentials.py | cli | def cli(env, identifier):
"""List virtual server credentials."""
vsi = SoftLayer.VSManager(env.client)
vs_id = helpers.resolve_id(vsi.resolve_ids, identifier, 'VS')
instance = vsi.get_instance(vs_id)
table = formatting.Table(['username', 'password'])
for item in instance['operatingSystem']['passwords']:
table.add_row([item['username'], item['password']])
env.fout(table) | python | def cli(env, identifier):
vsi = SoftLayer.VSManager(env.client)
vs_id = helpers.resolve_id(vsi.resolve_ids, identifier, 'VS')
instance = vsi.get_instance(vs_id)
table = formatting.Table(['username', 'password'])
for item in instance['operatingSystem']['passwords']:
table.add_row([item['username'], item['password']])
env.fout(table) | [
"def",
"cli",
"(",
"env",
",",
"identifier",
")",
":",
"vsi",
"=",
"SoftLayer",
".",
"VSManager",
"(",
"env",
".",
"client",
")",
"vs_id",
"=",
"helpers",
".",
"resolve_id",
"(",
"vsi",
".",
"resolve_ids",
",",
"identifier",
",",
"'VS'",
")",
"instance",
"=",
"vsi",
".",
"get_instance",
"(",
"vs_id",
")",
"table",
"=",
"formatting",
".",
"Table",
"(",
"[",
"'username'",
",",
"'password'",
"]",
")",
"for",
"item",
"in",
"instance",
"[",
"'operatingSystem'",
"]",
"[",
"'passwords'",
"]",
":",
"table",
".",
"add_row",
"(",
"[",
"item",
"[",
"'username'",
"]",
",",
"item",
"[",
"'password'",
"]",
"]",
")",
"env",
".",
"fout",
"(",
"table",
")"
]
| List virtual server credentials. | [
"List",
"virtual",
"server",
"credentials",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/CLI/virt/credentials.py#L15-L25 |
softlayer/softlayer-python | SoftLayer/CLI/object_storage/credential/__init__.py | CapacityCommands.list_commands | def list_commands(self, ctx):
"""List all sub-commands."""
commands = []
for filename in os.listdir(self.path):
if filename == '__init__.py':
continue
if filename.endswith('.py'):
commands.append(filename[:-3].replace("_", "-"))
commands.sort()
return commands | python | def list_commands(self, ctx):
commands = []
for filename in os.listdir(self.path):
if filename == '__init__.py':
continue
if filename.endswith('.py'):
commands.append(filename[:-3].replace("_", "-"))
commands.sort()
return commands | [
"def",
"list_commands",
"(",
"self",
",",
"ctx",
")",
":",
"commands",
"=",
"[",
"]",
"for",
"filename",
"in",
"os",
".",
"listdir",
"(",
"self",
".",
"path",
")",
":",
"if",
"filename",
"==",
"'__init__.py'",
":",
"continue",
"if",
"filename",
".",
"endswith",
"(",
"'.py'",
")",
":",
"commands",
".",
"append",
"(",
"filename",
"[",
":",
"-",
"3",
"]",
".",
"replace",
"(",
"\"_\"",
",",
"\"-\"",
")",
")",
"commands",
".",
"sort",
"(",
")",
"return",
"commands"
]
| List all sub-commands. | [
"List",
"all",
"sub",
"-",
"commands",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/CLI/object_storage/credential/__init__.py#L20-L29 |
softlayer/softlayer-python | SoftLayer/CLI/object_storage/credential/__init__.py | CapacityCommands.get_command | def get_command(self, ctx, cmd_name):
"""Get command for click."""
path = "%s.%s" % (__name__, cmd_name)
path = path.replace("-", "_")
module = importlib.import_module(path)
return getattr(module, 'cli') | python | def get_command(self, ctx, cmd_name):
path = "%s.%s" % (__name__, cmd_name)
path = path.replace("-", "_")
module = importlib.import_module(path)
return getattr(module, 'cli') | [
"def",
"get_command",
"(",
"self",
",",
"ctx",
",",
"cmd_name",
")",
":",
"path",
"=",
"\"%s.%s\"",
"%",
"(",
"__name__",
",",
"cmd_name",
")",
"path",
"=",
"path",
".",
"replace",
"(",
"\"-\"",
",",
"\"_\"",
")",
"module",
"=",
"importlib",
".",
"import_module",
"(",
"path",
")",
"return",
"getattr",
"(",
"module",
",",
"'cli'",
")"
]
| Get command for click. | [
"Get",
"command",
"for",
"click",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/CLI/object_storage/credential/__init__.py#L31-L36 |
softlayer/softlayer-python | SoftLayer/CLI/dns/record_edit.py | cli | def cli(env, zone_id, by_record, by_id, data, ttl):
"""Update DNS record."""
manager = SoftLayer.DNSManager(env.client)
zone_id = helpers.resolve_id(manager.resolve_ids, zone_id, name='zone')
results = manager.get_records(zone_id, host=by_record)
for result in results:
if by_id and str(result['id']) != by_id:
continue
result['data'] = data or result['data']
result['ttl'] = ttl or result['ttl']
manager.edit_record(result) | python | def cli(env, zone_id, by_record, by_id, data, ttl):
manager = SoftLayer.DNSManager(env.client)
zone_id = helpers.resolve_id(manager.resolve_ids, zone_id, name='zone')
results = manager.get_records(zone_id, host=by_record)
for result in results:
if by_id and str(result['id']) != by_id:
continue
result['data'] = data or result['data']
result['ttl'] = ttl or result['ttl']
manager.edit_record(result) | [
"def",
"cli",
"(",
"env",
",",
"zone_id",
",",
"by_record",
",",
"by_id",
",",
"data",
",",
"ttl",
")",
":",
"manager",
"=",
"SoftLayer",
".",
"DNSManager",
"(",
"env",
".",
"client",
")",
"zone_id",
"=",
"helpers",
".",
"resolve_id",
"(",
"manager",
".",
"resolve_ids",
",",
"zone_id",
",",
"name",
"=",
"'zone'",
")",
"results",
"=",
"manager",
".",
"get_records",
"(",
"zone_id",
",",
"host",
"=",
"by_record",
")",
"for",
"result",
"in",
"results",
":",
"if",
"by_id",
"and",
"str",
"(",
"result",
"[",
"'id'",
"]",
")",
"!=",
"by_id",
":",
"continue",
"result",
"[",
"'data'",
"]",
"=",
"data",
"or",
"result",
"[",
"'data'",
"]",
"result",
"[",
"'ttl'",
"]",
"=",
"ttl",
"or",
"result",
"[",
"'ttl'",
"]",
"manager",
".",
"edit_record",
"(",
"result",
")"
]
| Update DNS record. | [
"Update",
"DNS",
"record",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/CLI/dns/record_edit.py#L21-L33 |
softlayer/softlayer-python | SoftLayer/CLI/hardware/ready.py | cli | def cli(env, identifier, wait):
"""Check if a server is ready."""
compute = SoftLayer.HardwareManager(env.client)
compute_id = helpers.resolve_id(compute.resolve_ids, identifier,
'hardware')
ready = compute.wait_for_ready(compute_id, wait)
if ready:
env.fout("READY")
else:
raise exceptions.CLIAbort("Server %s not ready" % compute_id) | python | def cli(env, identifier, wait):
compute = SoftLayer.HardwareManager(env.client)
compute_id = helpers.resolve_id(compute.resolve_ids, identifier,
'hardware')
ready = compute.wait_for_ready(compute_id, wait)
if ready:
env.fout("READY")
else:
raise exceptions.CLIAbort("Server %s not ready" % compute_id) | [
"def",
"cli",
"(",
"env",
",",
"identifier",
",",
"wait",
")",
":",
"compute",
"=",
"SoftLayer",
".",
"HardwareManager",
"(",
"env",
".",
"client",
")",
"compute_id",
"=",
"helpers",
".",
"resolve_id",
"(",
"compute",
".",
"resolve_ids",
",",
"identifier",
",",
"'hardware'",
")",
"ready",
"=",
"compute",
".",
"wait_for_ready",
"(",
"compute_id",
",",
"wait",
")",
"if",
"ready",
":",
"env",
".",
"fout",
"(",
"\"READY\"",
")",
"else",
":",
"raise",
"exceptions",
".",
"CLIAbort",
"(",
"\"Server %s not ready\"",
"%",
"compute_id",
")"
]
| Check if a server is ready. | [
"Check",
"if",
"a",
"server",
"is",
"ready",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/CLI/hardware/ready.py#L17-L27 |
softlayer/softlayer-python | SoftLayer/CLI/ticket/summary.py | cli | def cli(env):
"""Summary info about tickets."""
mask = ('openTicketCount, closedTicketCount, '
'openBillingTicketCount, openOtherTicketCount, '
'openSalesTicketCount, openSupportTicketCount, '
'openAccountingTicketCount')
account = env.client['Account'].getObject(mask=mask)
table = formatting.Table(['Status', 'count'])
nested = formatting.Table(['Type', 'count'])
nested.add_row(['Accounting',
account['openAccountingTicketCount']])
nested.add_row(['Billing', account['openBillingTicketCount']])
nested.add_row(['Sales', account['openSalesTicketCount']])
nested.add_row(['Support', account['openSupportTicketCount']])
nested.add_row(['Other', account['openOtherTicketCount']])
nested.add_row(['Total', account['openTicketCount']])
table.add_row(['Open', nested])
table.add_row(['Closed', account['closedTicketCount']])
env.fout(table) | python | def cli(env):
mask = ('openTicketCount, closedTicketCount, '
'openBillingTicketCount, openOtherTicketCount, '
'openSalesTicketCount, openSupportTicketCount, '
'openAccountingTicketCount')
account = env.client['Account'].getObject(mask=mask)
table = formatting.Table(['Status', 'count'])
nested = formatting.Table(['Type', 'count'])
nested.add_row(['Accounting',
account['openAccountingTicketCount']])
nested.add_row(['Billing', account['openBillingTicketCount']])
nested.add_row(['Sales', account['openSalesTicketCount']])
nested.add_row(['Support', account['openSupportTicketCount']])
nested.add_row(['Other', account['openOtherTicketCount']])
nested.add_row(['Total', account['openTicketCount']])
table.add_row(['Open', nested])
table.add_row(['Closed', account['closedTicketCount']])
env.fout(table) | [
"def",
"cli",
"(",
"env",
")",
":",
"mask",
"=",
"(",
"'openTicketCount, closedTicketCount, '",
"'openBillingTicketCount, openOtherTicketCount, '",
"'openSalesTicketCount, openSupportTicketCount, '",
"'openAccountingTicketCount'",
")",
"account",
"=",
"env",
".",
"client",
"[",
"'Account'",
"]",
".",
"getObject",
"(",
"mask",
"=",
"mask",
")",
"table",
"=",
"formatting",
".",
"Table",
"(",
"[",
"'Status'",
",",
"'count'",
"]",
")",
"nested",
"=",
"formatting",
".",
"Table",
"(",
"[",
"'Type'",
",",
"'count'",
"]",
")",
"nested",
".",
"add_row",
"(",
"[",
"'Accounting'",
",",
"account",
"[",
"'openAccountingTicketCount'",
"]",
"]",
")",
"nested",
".",
"add_row",
"(",
"[",
"'Billing'",
",",
"account",
"[",
"'openBillingTicketCount'",
"]",
"]",
")",
"nested",
".",
"add_row",
"(",
"[",
"'Sales'",
",",
"account",
"[",
"'openSalesTicketCount'",
"]",
"]",
")",
"nested",
".",
"add_row",
"(",
"[",
"'Support'",
",",
"account",
"[",
"'openSupportTicketCount'",
"]",
"]",
")",
"nested",
".",
"add_row",
"(",
"[",
"'Other'",
",",
"account",
"[",
"'openOtherTicketCount'",
"]",
"]",
")",
"nested",
".",
"add_row",
"(",
"[",
"'Total'",
",",
"account",
"[",
"'openTicketCount'",
"]",
"]",
")",
"table",
".",
"add_row",
"(",
"[",
"'Open'",
",",
"nested",
"]",
")",
"table",
".",
"add_row",
"(",
"[",
"'Closed'",
",",
"account",
"[",
"'closedTicketCount'",
"]",
"]",
")",
"env",
".",
"fout",
"(",
"table",
")"
]
| Summary info about tickets. | [
"Summary",
"info",
"about",
"tickets",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/CLI/ticket/summary.py#L12-L33 |
softlayer/softlayer-python | SoftLayer/CLI/globalip/list.py | cli | def cli(env, ip_version):
"""List all global IPs."""
mgr = SoftLayer.NetworkManager(env.client)
table = formatting.Table(['id', 'ip', 'assigned', 'target'])
version = None
if ip_version == 'v4':
version = 4
elif ip_version == 'v6':
version = 6
ips = mgr.list_global_ips(version=version)
for ip_address in ips:
assigned = 'No'
target = 'None'
if ip_address.get('destinationIpAddress'):
dest = ip_address['destinationIpAddress']
assigned = 'Yes'
target = dest['ipAddress']
virtual_guest = dest.get('virtualGuest')
if virtual_guest:
target += (' (%s)'
% virtual_guest['fullyQualifiedDomainName'])
elif ip_address['destinationIpAddress'].get('hardware'):
target += (' (%s)'
% dest['hardware']['fullyQualifiedDomainName'])
table.add_row([ip_address['id'],
ip_address['ipAddress']['ipAddress'],
assigned,
target])
env.fout(table) | python | def cli(env, ip_version):
mgr = SoftLayer.NetworkManager(env.client)
table = formatting.Table(['id', 'ip', 'assigned', 'target'])
version = None
if ip_version == 'v4':
version = 4
elif ip_version == 'v6':
version = 6
ips = mgr.list_global_ips(version=version)
for ip_address in ips:
assigned = 'No'
target = 'None'
if ip_address.get('destinationIpAddress'):
dest = ip_address['destinationIpAddress']
assigned = 'Yes'
target = dest['ipAddress']
virtual_guest = dest.get('virtualGuest')
if virtual_guest:
target += (' (%s)'
% virtual_guest['fullyQualifiedDomainName'])
elif ip_address['destinationIpAddress'].get('hardware'):
target += (' (%s)'
% dest['hardware']['fullyQualifiedDomainName'])
table.add_row([ip_address['id'],
ip_address['ipAddress']['ipAddress'],
assigned,
target])
env.fout(table) | [
"def",
"cli",
"(",
"env",
",",
"ip_version",
")",
":",
"mgr",
"=",
"SoftLayer",
".",
"NetworkManager",
"(",
"env",
".",
"client",
")",
"table",
"=",
"formatting",
".",
"Table",
"(",
"[",
"'id'",
",",
"'ip'",
",",
"'assigned'",
",",
"'target'",
"]",
")",
"version",
"=",
"None",
"if",
"ip_version",
"==",
"'v4'",
":",
"version",
"=",
"4",
"elif",
"ip_version",
"==",
"'v6'",
":",
"version",
"=",
"6",
"ips",
"=",
"mgr",
".",
"list_global_ips",
"(",
"version",
"=",
"version",
")",
"for",
"ip_address",
"in",
"ips",
":",
"assigned",
"=",
"'No'",
"target",
"=",
"'None'",
"if",
"ip_address",
".",
"get",
"(",
"'destinationIpAddress'",
")",
":",
"dest",
"=",
"ip_address",
"[",
"'destinationIpAddress'",
"]",
"assigned",
"=",
"'Yes'",
"target",
"=",
"dest",
"[",
"'ipAddress'",
"]",
"virtual_guest",
"=",
"dest",
".",
"get",
"(",
"'virtualGuest'",
")",
"if",
"virtual_guest",
":",
"target",
"+=",
"(",
"' (%s)'",
"%",
"virtual_guest",
"[",
"'fullyQualifiedDomainName'",
"]",
")",
"elif",
"ip_address",
"[",
"'destinationIpAddress'",
"]",
".",
"get",
"(",
"'hardware'",
")",
":",
"target",
"+=",
"(",
"' (%s)'",
"%",
"dest",
"[",
"'hardware'",
"]",
"[",
"'fullyQualifiedDomainName'",
"]",
")",
"table",
".",
"add_row",
"(",
"[",
"ip_address",
"[",
"'id'",
"]",
",",
"ip_address",
"[",
"'ipAddress'",
"]",
"[",
"'ipAddress'",
"]",
",",
"assigned",
",",
"target",
"]",
")",
"env",
".",
"fout",
"(",
"table",
")"
]
| List all global IPs. | [
"List",
"all",
"global",
"IPs",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/CLI/globalip/list.py#L16-L50 |
softlayer/softlayer-python | SoftLayer/CLI/globalip/cancel.py | cli | def cli(env, identifier):
"""Cancel global IP."""
mgr = SoftLayer.NetworkManager(env.client)
global_ip_id = helpers.resolve_id(mgr.resolve_global_ip_ids, identifier,
name='global ip')
if not (env.skip_confirmations or formatting.no_going_back(global_ip_id)):
raise exceptions.CLIAbort('Aborted')
mgr.cancel_global_ip(global_ip_id) | python | def cli(env, identifier):
mgr = SoftLayer.NetworkManager(env.client)
global_ip_id = helpers.resolve_id(mgr.resolve_global_ip_ids, identifier,
name='global ip')
if not (env.skip_confirmations or formatting.no_going_back(global_ip_id)):
raise exceptions.CLIAbort('Aborted')
mgr.cancel_global_ip(global_ip_id) | [
"def",
"cli",
"(",
"env",
",",
"identifier",
")",
":",
"mgr",
"=",
"SoftLayer",
".",
"NetworkManager",
"(",
"env",
".",
"client",
")",
"global_ip_id",
"=",
"helpers",
".",
"resolve_id",
"(",
"mgr",
".",
"resolve_global_ip_ids",
",",
"identifier",
",",
"name",
"=",
"'global ip'",
")",
"if",
"not",
"(",
"env",
".",
"skip_confirmations",
"or",
"formatting",
".",
"no_going_back",
"(",
"global_ip_id",
")",
")",
":",
"raise",
"exceptions",
".",
"CLIAbort",
"(",
"'Aborted'",
")",
"mgr",
".",
"cancel_global_ip",
"(",
"global_ip_id",
")"
]
| Cancel global IP. | [
"Cancel",
"global",
"IP",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/CLI/globalip/cancel.py#L16-L26 |
softlayer/softlayer-python | SoftLayer/API.py | create_client_from_env | def create_client_from_env(username=None,
api_key=None,
endpoint_url=None,
timeout=None,
auth=None,
config_file=None,
proxy=None,
user_agent=None,
transport=None,
verify=True):
"""Creates a SoftLayer API client using your environment.
Settings are loaded via keyword arguments, environemtal variables and
config file.
:param username: an optional API username if you wish to bypass the
package's built-in username
:param api_key: an optional API key if you wish to bypass the package's
built in API key
:param endpoint_url: the API endpoint base URL you wish to connect to.
Set this to API_PRIVATE_ENDPOINT to connect via SoftLayer's private
network.
:param proxy: proxy to be used to make API calls
:param integer timeout: timeout for API requests
:param auth: an object which responds to get_headers() to be inserted into
the xml-rpc headers. Example: `BasicAuthentication`
:param config_file: A path to a configuration file used to load settings
:param user_agent: an optional User Agent to report when making API
calls if you wish to bypass the packages built in User Agent string
:param transport: An object that's callable with this signature:
transport(SoftLayer.transports.Request)
:param bool verify: decide to verify the server's SSL/TLS cert. DO NOT SET
TO FALSE WITHOUT UNDERSTANDING THE IMPLICATIONS.
Usage:
>>> import SoftLayer
>>> client = SoftLayer.create_client_from_env()
>>> resp = client.call('Account', 'getObject')
>>> resp['companyName']
'Your Company'
"""
settings = config.get_client_settings(username=username,
api_key=api_key,
endpoint_url=endpoint_url,
timeout=timeout,
proxy=proxy,
verify=verify,
config_file=config_file)
if transport is None:
url = settings.get('endpoint_url')
if url is not None and '/rest' in url:
# If this looks like a rest endpoint, use the rest transport
transport = transports.RestTransport(
endpoint_url=settings.get('endpoint_url'),
proxy=settings.get('proxy'),
timeout=settings.get('timeout'),
user_agent=user_agent,
verify=verify,
)
else:
# Default the transport to use XMLRPC
transport = transports.XmlRpcTransport(
endpoint_url=settings.get('endpoint_url'),
proxy=settings.get('proxy'),
timeout=settings.get('timeout'),
user_agent=user_agent,
verify=verify,
)
# If we have enough information to make an auth driver, let's do it
if auth is None and settings.get('username') and settings.get('api_key'):
# NOTE(kmcdonald): some transports mask other transports, so this is
# a way to find the 'real' one
real_transport = getattr(transport, 'transport', transport)
if isinstance(real_transport, transports.XmlRpcTransport):
auth = slauth.BasicAuthentication(
settings.get('username'),
settings.get('api_key'),
)
elif isinstance(real_transport, transports.RestTransport):
auth = slauth.BasicHTTPAuthentication(
settings.get('username'),
settings.get('api_key'),
)
return BaseClient(auth=auth, transport=transport) | python | def create_client_from_env(username=None,
api_key=None,
endpoint_url=None,
timeout=None,
auth=None,
config_file=None,
proxy=None,
user_agent=None,
transport=None,
verify=True):
settings = config.get_client_settings(username=username,
api_key=api_key,
endpoint_url=endpoint_url,
timeout=timeout,
proxy=proxy,
verify=verify,
config_file=config_file)
if transport is None:
url = settings.get('endpoint_url')
if url is not None and '/rest' in url:
transport = transports.RestTransport(
endpoint_url=settings.get('endpoint_url'),
proxy=settings.get('proxy'),
timeout=settings.get('timeout'),
user_agent=user_agent,
verify=verify,
)
else:
transport = transports.XmlRpcTransport(
endpoint_url=settings.get('endpoint_url'),
proxy=settings.get('proxy'),
timeout=settings.get('timeout'),
user_agent=user_agent,
verify=verify,
)
if auth is None and settings.get('username') and settings.get('api_key'):
real_transport = getattr(transport, 'transport', transport)
if isinstance(real_transport, transports.XmlRpcTransport):
auth = slauth.BasicAuthentication(
settings.get('username'),
settings.get('api_key'),
)
elif isinstance(real_transport, transports.RestTransport):
auth = slauth.BasicHTTPAuthentication(
settings.get('username'),
settings.get('api_key'),
)
return BaseClient(auth=auth, transport=transport) | [
"def",
"create_client_from_env",
"(",
"username",
"=",
"None",
",",
"api_key",
"=",
"None",
",",
"endpoint_url",
"=",
"None",
",",
"timeout",
"=",
"None",
",",
"auth",
"=",
"None",
",",
"config_file",
"=",
"None",
",",
"proxy",
"=",
"None",
",",
"user_agent",
"=",
"None",
",",
"transport",
"=",
"None",
",",
"verify",
"=",
"True",
")",
":",
"settings",
"=",
"config",
".",
"get_client_settings",
"(",
"username",
"=",
"username",
",",
"api_key",
"=",
"api_key",
",",
"endpoint_url",
"=",
"endpoint_url",
",",
"timeout",
"=",
"timeout",
",",
"proxy",
"=",
"proxy",
",",
"verify",
"=",
"verify",
",",
"config_file",
"=",
"config_file",
")",
"if",
"transport",
"is",
"None",
":",
"url",
"=",
"settings",
".",
"get",
"(",
"'endpoint_url'",
")",
"if",
"url",
"is",
"not",
"None",
"and",
"'/rest'",
"in",
"url",
":",
"# If this looks like a rest endpoint, use the rest transport",
"transport",
"=",
"transports",
".",
"RestTransport",
"(",
"endpoint_url",
"=",
"settings",
".",
"get",
"(",
"'endpoint_url'",
")",
",",
"proxy",
"=",
"settings",
".",
"get",
"(",
"'proxy'",
")",
",",
"timeout",
"=",
"settings",
".",
"get",
"(",
"'timeout'",
")",
",",
"user_agent",
"=",
"user_agent",
",",
"verify",
"=",
"verify",
",",
")",
"else",
":",
"# Default the transport to use XMLRPC",
"transport",
"=",
"transports",
".",
"XmlRpcTransport",
"(",
"endpoint_url",
"=",
"settings",
".",
"get",
"(",
"'endpoint_url'",
")",
",",
"proxy",
"=",
"settings",
".",
"get",
"(",
"'proxy'",
")",
",",
"timeout",
"=",
"settings",
".",
"get",
"(",
"'timeout'",
")",
",",
"user_agent",
"=",
"user_agent",
",",
"verify",
"=",
"verify",
",",
")",
"# If we have enough information to make an auth driver, let's do it",
"if",
"auth",
"is",
"None",
"and",
"settings",
".",
"get",
"(",
"'username'",
")",
"and",
"settings",
".",
"get",
"(",
"'api_key'",
")",
":",
"# NOTE(kmcdonald): some transports mask other transports, so this is",
"# a way to find the 'real' one",
"real_transport",
"=",
"getattr",
"(",
"transport",
",",
"'transport'",
",",
"transport",
")",
"if",
"isinstance",
"(",
"real_transport",
",",
"transports",
".",
"XmlRpcTransport",
")",
":",
"auth",
"=",
"slauth",
".",
"BasicAuthentication",
"(",
"settings",
".",
"get",
"(",
"'username'",
")",
",",
"settings",
".",
"get",
"(",
"'api_key'",
")",
",",
")",
"elif",
"isinstance",
"(",
"real_transport",
",",
"transports",
".",
"RestTransport",
")",
":",
"auth",
"=",
"slauth",
".",
"BasicHTTPAuthentication",
"(",
"settings",
".",
"get",
"(",
"'username'",
")",
",",
"settings",
".",
"get",
"(",
"'api_key'",
")",
",",
")",
"return",
"BaseClient",
"(",
"auth",
"=",
"auth",
",",
"transport",
"=",
"transport",
")"
]
| Creates a SoftLayer API client using your environment.
Settings are loaded via keyword arguments, environemtal variables and
config file.
:param username: an optional API username if you wish to bypass the
package's built-in username
:param api_key: an optional API key if you wish to bypass the package's
built in API key
:param endpoint_url: the API endpoint base URL you wish to connect to.
Set this to API_PRIVATE_ENDPOINT to connect via SoftLayer's private
network.
:param proxy: proxy to be used to make API calls
:param integer timeout: timeout for API requests
:param auth: an object which responds to get_headers() to be inserted into
the xml-rpc headers. Example: `BasicAuthentication`
:param config_file: A path to a configuration file used to load settings
:param user_agent: an optional User Agent to report when making API
calls if you wish to bypass the packages built in User Agent string
:param transport: An object that's callable with this signature:
transport(SoftLayer.transports.Request)
:param bool verify: decide to verify the server's SSL/TLS cert. DO NOT SET
TO FALSE WITHOUT UNDERSTANDING THE IMPLICATIONS.
Usage:
>>> import SoftLayer
>>> client = SoftLayer.create_client_from_env()
>>> resp = client.call('Account', 'getObject')
>>> resp['companyName']
'Your Company' | [
"Creates",
"a",
"SoftLayer",
"API",
"client",
"using",
"your",
"environment",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/API.py#L41-L131 |
softlayer/softlayer-python | SoftLayer/API.py | BaseClient.authenticate_with_password | def authenticate_with_password(self, username, password,
security_question_id=None,
security_question_answer=None):
"""Performs Username/Password Authentication
:param string username: your SoftLayer username
:param string password: your SoftLayer password
:param int security_question_id: The security question id to answer
:param string security_question_answer: The answer to the security
question
"""
self.auth = None
res = self.call('User_Customer', 'getPortalLoginToken',
username,
password,
security_question_id,
security_question_answer)
self.auth = slauth.TokenAuthentication(res['userId'], res['hash'])
return res['userId'], res['hash'] | python | def authenticate_with_password(self, username, password,
security_question_id=None,
security_question_answer=None):
self.auth = None
res = self.call('User_Customer', 'getPortalLoginToken',
username,
password,
security_question_id,
security_question_answer)
self.auth = slauth.TokenAuthentication(res['userId'], res['hash'])
return res['userId'], res['hash'] | [
"def",
"authenticate_with_password",
"(",
"self",
",",
"username",
",",
"password",
",",
"security_question_id",
"=",
"None",
",",
"security_question_answer",
"=",
"None",
")",
":",
"self",
".",
"auth",
"=",
"None",
"res",
"=",
"self",
".",
"call",
"(",
"'User_Customer'",
",",
"'getPortalLoginToken'",
",",
"username",
",",
"password",
",",
"security_question_id",
",",
"security_question_answer",
")",
"self",
".",
"auth",
"=",
"slauth",
".",
"TokenAuthentication",
"(",
"res",
"[",
"'userId'",
"]",
",",
"res",
"[",
"'hash'",
"]",
")",
"return",
"res",
"[",
"'userId'",
"]",
",",
"res",
"[",
"'hash'",
"]"
]
| Performs Username/Password Authentication
:param string username: your SoftLayer username
:param string password: your SoftLayer password
:param int security_question_id: The security question id to answer
:param string security_question_answer: The answer to the security
question | [
"Performs",
"Username",
"/",
"Password",
"Authentication"
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/API.py#L158-L177 |
softlayer/softlayer-python | SoftLayer/API.py | BaseClient.call | def call(self, service, method, *args, **kwargs):
"""Make a SoftLayer API call.
:param method: the method to call on the service
:param \\*args: (optional) arguments for the remote call
:param id: (optional) id for the resource
:param mask: (optional) object mask
:param dict filter: (optional) filter dict
:param dict headers: (optional) optional XML-RPC headers
:param boolean compress: (optional) Enable/Disable HTTP compression
:param dict raw_headers: (optional) HTTP transport headers
:param int limit: (optional) return at most this many results
:param int offset: (optional) offset results by this many
:param boolean iter: (optional) if True, returns a generator with the
results
:param bool verify: verify SSL cert
:param cert: client certificate path
Usage:
>>> import SoftLayer
>>> client = SoftLayer.create_client_from_env()
>>> client.call('Account', 'getVirtualGuests', mask="id", limit=10)
[...]
"""
if kwargs.pop('iter', False):
# Most of the codebase assumes a non-generator will be returned, so casting to list
# keeps those sections working
return list(self.iter_call(service, method, *args, **kwargs))
invalid_kwargs = set(kwargs.keys()) - VALID_CALL_ARGS
if invalid_kwargs:
raise TypeError(
'Invalid keyword arguments: %s' % ','.join(invalid_kwargs))
if self._prefix and not service.startswith(self._prefix):
service = self._prefix + service
http_headers = {'Accept': '*/*'}
if kwargs.get('compress', True):
http_headers['Accept-Encoding'] = 'gzip, deflate, compress'
else:
http_headers['Accept-Encoding'] = None
if kwargs.get('raw_headers'):
http_headers.update(kwargs.get('raw_headers'))
request = transports.Request()
request.service = service
request.method = method
request.args = args
request.transport_headers = http_headers
request.identifier = kwargs.get('id')
request.mask = kwargs.get('mask')
request.filter = kwargs.get('filter')
request.limit = kwargs.get('limit')
request.offset = kwargs.get('offset')
if kwargs.get('verify') is not None:
request.verify = kwargs.get('verify')
if self.auth:
extra_headers = self.auth.get_headers()
if extra_headers:
warnings.warn("auth.get_headers() is deprecated and will be "
"removed in the next major version",
DeprecationWarning)
request.headers.update(extra_headers)
request = self.auth.get_request(request)
request.headers.update(kwargs.get('headers', {}))
return self.transport(request) | python | def call(self, service, method, *args, **kwargs):
if kwargs.pop('iter', False):
return list(self.iter_call(service, method, *args, **kwargs))
invalid_kwargs = set(kwargs.keys()) - VALID_CALL_ARGS
if invalid_kwargs:
raise TypeError(
'Invalid keyword arguments: %s' % ','.join(invalid_kwargs))
if self._prefix and not service.startswith(self._prefix):
service = self._prefix + service
http_headers = {'Accept': '*/*'}
if kwargs.get('compress', True):
http_headers['Accept-Encoding'] = 'gzip, deflate, compress'
else:
http_headers['Accept-Encoding'] = None
if kwargs.get('raw_headers'):
http_headers.update(kwargs.get('raw_headers'))
request = transports.Request()
request.service = service
request.method = method
request.args = args
request.transport_headers = http_headers
request.identifier = kwargs.get('id')
request.mask = kwargs.get('mask')
request.filter = kwargs.get('filter')
request.limit = kwargs.get('limit')
request.offset = kwargs.get('offset')
if kwargs.get('verify') is not None:
request.verify = kwargs.get('verify')
if self.auth:
extra_headers = self.auth.get_headers()
if extra_headers:
warnings.warn("auth.get_headers() is deprecated and will be "
"removed in the next major version",
DeprecationWarning)
request.headers.update(extra_headers)
request = self.auth.get_request(request)
request.headers.update(kwargs.get('headers', {}))
return self.transport(request) | [
"def",
"call",
"(",
"self",
",",
"service",
",",
"method",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"if",
"kwargs",
".",
"pop",
"(",
"'iter'",
",",
"False",
")",
":",
"# Most of the codebase assumes a non-generator will be returned, so casting to list",
"# keeps those sections working",
"return",
"list",
"(",
"self",
".",
"iter_call",
"(",
"service",
",",
"method",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
")",
"invalid_kwargs",
"=",
"set",
"(",
"kwargs",
".",
"keys",
"(",
")",
")",
"-",
"VALID_CALL_ARGS",
"if",
"invalid_kwargs",
":",
"raise",
"TypeError",
"(",
"'Invalid keyword arguments: %s'",
"%",
"','",
".",
"join",
"(",
"invalid_kwargs",
")",
")",
"if",
"self",
".",
"_prefix",
"and",
"not",
"service",
".",
"startswith",
"(",
"self",
".",
"_prefix",
")",
":",
"service",
"=",
"self",
".",
"_prefix",
"+",
"service",
"http_headers",
"=",
"{",
"'Accept'",
":",
"'*/*'",
"}",
"if",
"kwargs",
".",
"get",
"(",
"'compress'",
",",
"True",
")",
":",
"http_headers",
"[",
"'Accept-Encoding'",
"]",
"=",
"'gzip, deflate, compress'",
"else",
":",
"http_headers",
"[",
"'Accept-Encoding'",
"]",
"=",
"None",
"if",
"kwargs",
".",
"get",
"(",
"'raw_headers'",
")",
":",
"http_headers",
".",
"update",
"(",
"kwargs",
".",
"get",
"(",
"'raw_headers'",
")",
")",
"request",
"=",
"transports",
".",
"Request",
"(",
")",
"request",
".",
"service",
"=",
"service",
"request",
".",
"method",
"=",
"method",
"request",
".",
"args",
"=",
"args",
"request",
".",
"transport_headers",
"=",
"http_headers",
"request",
".",
"identifier",
"=",
"kwargs",
".",
"get",
"(",
"'id'",
")",
"request",
".",
"mask",
"=",
"kwargs",
".",
"get",
"(",
"'mask'",
")",
"request",
".",
"filter",
"=",
"kwargs",
".",
"get",
"(",
"'filter'",
")",
"request",
".",
"limit",
"=",
"kwargs",
".",
"get",
"(",
"'limit'",
")",
"request",
".",
"offset",
"=",
"kwargs",
".",
"get",
"(",
"'offset'",
")",
"if",
"kwargs",
".",
"get",
"(",
"'verify'",
")",
"is",
"not",
"None",
":",
"request",
".",
"verify",
"=",
"kwargs",
".",
"get",
"(",
"'verify'",
")",
"if",
"self",
".",
"auth",
":",
"extra_headers",
"=",
"self",
".",
"auth",
".",
"get_headers",
"(",
")",
"if",
"extra_headers",
":",
"warnings",
".",
"warn",
"(",
"\"auth.get_headers() is deprecated and will be \"",
"\"removed in the next major version\"",
",",
"DeprecationWarning",
")",
"request",
".",
"headers",
".",
"update",
"(",
"extra_headers",
")",
"request",
"=",
"self",
".",
"auth",
".",
"get_request",
"(",
"request",
")",
"request",
".",
"headers",
".",
"update",
"(",
"kwargs",
".",
"get",
"(",
"'headers'",
",",
"{",
"}",
")",
")",
"return",
"self",
".",
"transport",
"(",
"request",
")"
]
| Make a SoftLayer API call.
:param method: the method to call on the service
:param \\*args: (optional) arguments for the remote call
:param id: (optional) id for the resource
:param mask: (optional) object mask
:param dict filter: (optional) filter dict
:param dict headers: (optional) optional XML-RPC headers
:param boolean compress: (optional) Enable/Disable HTTP compression
:param dict raw_headers: (optional) HTTP transport headers
:param int limit: (optional) return at most this many results
:param int offset: (optional) offset results by this many
:param boolean iter: (optional) if True, returns a generator with the
results
:param bool verify: verify SSL cert
:param cert: client certificate path
Usage:
>>> import SoftLayer
>>> client = SoftLayer.create_client_from_env()
>>> client.call('Account', 'getVirtualGuests', mask="id", limit=10)
[...] | [
"Make",
"a",
"SoftLayer",
"API",
"call",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/API.py#L193-L265 |
softlayer/softlayer-python | SoftLayer/API.py | BaseClient.iter_call | def iter_call(self, service, method, *args, **kwargs):
"""A generator that deals with paginating through results.
:param service: the name of the SoftLayer API service
:param method: the method to call on the service
:param integer limit: result size for each API call (defaults to 100)
:param \\*args: same optional arguments that ``Service.call`` takes
:param \\*\\*kwargs: same optional keyword arguments that ``Service.call`` takes
"""
limit = kwargs.pop('limit', 100)
offset = kwargs.pop('offset', 0)
if limit <= 0:
raise AttributeError("Limit size should be greater than zero.")
# Set to make unit tests, which call this function directly, play nice.
kwargs['iter'] = False
result_count = 0
keep_looping = True
while keep_looping:
# Get the next results
results = self.call(service, method, offset=offset, limit=limit, *args, **kwargs)
# Apparently this method doesn't return a list.
# Why are you even iterating over this?
if not isinstance(results, transports.SoftLayerListResult):
if isinstance(results, list):
# Close enough, this makes testing a lot easier
results = transports.SoftLayerListResult(results, len(results))
else:
yield results
return
for item in results:
yield item
result_count += 1
# Got less results than requested, we are at the end
if len(results) < limit:
keep_looping = False
# Got all the needed items
if result_count >= results.total_count:
keep_looping = False
offset += limit | python | def iter_call(self, service, method, *args, **kwargs):
limit = kwargs.pop('limit', 100)
offset = kwargs.pop('offset', 0)
if limit <= 0:
raise AttributeError("Limit size should be greater than zero.")
kwargs['iter'] = False
result_count = 0
keep_looping = True
while keep_looping:
results = self.call(service, method, offset=offset, limit=limit, *args, **kwargs)
if not isinstance(results, transports.SoftLayerListResult):
if isinstance(results, list):
results = transports.SoftLayerListResult(results, len(results))
else:
yield results
return
for item in results:
yield item
result_count += 1
if len(results) < limit:
keep_looping = False
if result_count >= results.total_count:
keep_looping = False
offset += limit | [
"def",
"iter_call",
"(",
"self",
",",
"service",
",",
"method",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"limit",
"=",
"kwargs",
".",
"pop",
"(",
"'limit'",
",",
"100",
")",
"offset",
"=",
"kwargs",
".",
"pop",
"(",
"'offset'",
",",
"0",
")",
"if",
"limit",
"<=",
"0",
":",
"raise",
"AttributeError",
"(",
"\"Limit size should be greater than zero.\"",
")",
"# Set to make unit tests, which call this function directly, play nice.",
"kwargs",
"[",
"'iter'",
"]",
"=",
"False",
"result_count",
"=",
"0",
"keep_looping",
"=",
"True",
"while",
"keep_looping",
":",
"# Get the next results",
"results",
"=",
"self",
".",
"call",
"(",
"service",
",",
"method",
",",
"offset",
"=",
"offset",
",",
"limit",
"=",
"limit",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
"# Apparently this method doesn't return a list.",
"# Why are you even iterating over this?",
"if",
"not",
"isinstance",
"(",
"results",
",",
"transports",
".",
"SoftLayerListResult",
")",
":",
"if",
"isinstance",
"(",
"results",
",",
"list",
")",
":",
"# Close enough, this makes testing a lot easier",
"results",
"=",
"transports",
".",
"SoftLayerListResult",
"(",
"results",
",",
"len",
"(",
"results",
")",
")",
"else",
":",
"yield",
"results",
"return",
"for",
"item",
"in",
"results",
":",
"yield",
"item",
"result_count",
"+=",
"1",
"# Got less results than requested, we are at the end",
"if",
"len",
"(",
"results",
")",
"<",
"limit",
":",
"keep_looping",
"=",
"False",
"# Got all the needed items",
"if",
"result_count",
">=",
"results",
".",
"total_count",
":",
"keep_looping",
"=",
"False",
"offset",
"+=",
"limit"
]
| A generator that deals with paginating through results.
:param service: the name of the SoftLayer API service
:param method: the method to call on the service
:param integer limit: result size for each API call (defaults to 100)
:param \\*args: same optional arguments that ``Service.call`` takes
:param \\*\\*kwargs: same optional keyword arguments that ``Service.call`` takes | [
"A",
"generator",
"that",
"deals",
"with",
"paginating",
"through",
"results",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/API.py#L269-L316 |
softlayer/softlayer-python | SoftLayer/API.py | Service.call | def call(self, name, *args, **kwargs):
"""Make a SoftLayer API call
:param service: the name of the SoftLayer API service
:param method: the method to call on the service
:param \\*args: same optional arguments that ``BaseClient.call`` takes
:param \\*\\*kwargs: same optional keyword arguments that
``BaseClient.call`` takes
:param service: the name of the SoftLayer API service
Usage:
>>> import SoftLayer
>>> client = SoftLayer.create_client_from_env()
>>> client['Account'].getVirtualGuests(mask="id", limit=10)
[...]
"""
return self.client.call(self.name, name, *args, **kwargs) | python | def call(self, name, *args, **kwargs):
return self.client.call(self.name, name, *args, **kwargs) | [
"def",
"call",
"(",
"self",
",",
"name",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"return",
"self",
".",
"client",
".",
"call",
"(",
"self",
".",
"name",
",",
"name",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")"
]
| Make a SoftLayer API call
:param service: the name of the SoftLayer API service
:param method: the method to call on the service
:param \\*args: same optional arguments that ``BaseClient.call`` takes
:param \\*\\*kwargs: same optional keyword arguments that
``BaseClient.call`` takes
:param service: the name of the SoftLayer API service
Usage:
>>> import SoftLayer
>>> client = SoftLayer.create_client_from_env()
>>> client['Account'].getVirtualGuests(mask="id", limit=10)
[...] | [
"Make",
"a",
"SoftLayer",
"API",
"call"
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/API.py#L339-L357 |
softlayer/softlayer-python | SoftLayer/API.py | Service.iter_call | def iter_call(self, name, *args, **kwargs):
"""A generator that deals with paginating through results.
:param method: the method to call on the service
:param integer chunk: result size for each API call
:param \\*args: same optional arguments that ``Service.call`` takes
:param \\*\\*kwargs: same optional keyword arguments that
``Service.call`` takes
Usage:
>>> import SoftLayer
>>> client = SoftLayer.create_client_from_env()
>>> gen = client.call('Account', 'getVirtualGuests', iter=True)
>>> for virtual_guest in gen:
... virtual_guest['id']
...
1234
4321
"""
return self.client.iter_call(self.name, name, *args, **kwargs) | python | def iter_call(self, name, *args, **kwargs):
return self.client.iter_call(self.name, name, *args, **kwargs) | [
"def",
"iter_call",
"(",
"self",
",",
"name",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")",
":",
"return",
"self",
".",
"client",
".",
"iter_call",
"(",
"self",
".",
"name",
",",
"name",
",",
"*",
"args",
",",
"*",
"*",
"kwargs",
")"
]
| A generator that deals with paginating through results.
:param method: the method to call on the service
:param integer chunk: result size for each API call
:param \\*args: same optional arguments that ``Service.call`` takes
:param \\*\\*kwargs: same optional keyword arguments that
``Service.call`` takes
Usage:
>>> import SoftLayer
>>> client = SoftLayer.create_client_from_env()
>>> gen = client.call('Account', 'getVirtualGuests', iter=True)
>>> for virtual_guest in gen:
... virtual_guest['id']
...
1234
4321 | [
"A",
"generator",
"that",
"deals",
"with",
"paginating",
"through",
"results",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/API.py#L361-L381 |
softlayer/softlayer-python | SoftLayer/CLI/object_storage/credential/list.py | cli | def cli(env, identifier):
"""Retrieve credentials used for generating an AWS signature. Max of 2."""
mgr = SoftLayer.ObjectStorageManager(env.client)
credential_list = mgr.list_credential(identifier)
table = formatting.Table(['id', 'password', 'username', 'type_name'])
for credential in credential_list:
table.add_row([
credential['id'],
credential['password'],
credential['username'],
credential['type']['name']
])
env.fout(table) | python | def cli(env, identifier):
mgr = SoftLayer.ObjectStorageManager(env.client)
credential_list = mgr.list_credential(identifier)
table = formatting.Table(['id', 'password', 'username', 'type_name'])
for credential in credential_list:
table.add_row([
credential['id'],
credential['password'],
credential['username'],
credential['type']['name']
])
env.fout(table) | [
"def",
"cli",
"(",
"env",
",",
"identifier",
")",
":",
"mgr",
"=",
"SoftLayer",
".",
"ObjectStorageManager",
"(",
"env",
".",
"client",
")",
"credential_list",
"=",
"mgr",
".",
"list_credential",
"(",
"identifier",
")",
"table",
"=",
"formatting",
".",
"Table",
"(",
"[",
"'id'",
",",
"'password'",
",",
"'username'",
",",
"'type_name'",
"]",
")",
"for",
"credential",
"in",
"credential_list",
":",
"table",
".",
"add_row",
"(",
"[",
"credential",
"[",
"'id'",
"]",
",",
"credential",
"[",
"'password'",
"]",
",",
"credential",
"[",
"'username'",
"]",
",",
"credential",
"[",
"'type'",
"]",
"[",
"'name'",
"]",
"]",
")",
"env",
".",
"fout",
"(",
"table",
")"
]
| Retrieve credentials used for generating an AWS signature. Max of 2. | [
"Retrieve",
"credentials",
"used",
"for",
"generating",
"an",
"AWS",
"signature",
".",
"Max",
"of",
"2",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/CLI/object_storage/credential/list.py#L14-L29 |
softlayer/softlayer-python | SoftLayer/CLI/dedicatedhost/list.py | cli | def cli(env, sortby, cpu, columns, datacenter, name, memory, disk, tag):
"""List dedicated host."""
mgr = SoftLayer.DedicatedHostManager(env.client)
hosts = mgr.list_instances(cpus=cpu,
datacenter=datacenter,
hostname=name,
memory=memory,
disk=disk,
tags=tag,
mask=columns.mask())
table = formatting.Table(columns.columns)
table.sortby = sortby
for host in hosts:
table.add_row([value or formatting.blank()
for value in columns.row(host)])
env.fout(table) | python | def cli(env, sortby, cpu, columns, datacenter, name, memory, disk, tag):
mgr = SoftLayer.DedicatedHostManager(env.client)
hosts = mgr.list_instances(cpus=cpu,
datacenter=datacenter,
hostname=name,
memory=memory,
disk=disk,
tags=tag,
mask=columns.mask())
table = formatting.Table(columns.columns)
table.sortby = sortby
for host in hosts:
table.add_row([value or formatting.blank()
for value in columns.row(host)])
env.fout(table) | [
"def",
"cli",
"(",
"env",
",",
"sortby",
",",
"cpu",
",",
"columns",
",",
"datacenter",
",",
"name",
",",
"memory",
",",
"disk",
",",
"tag",
")",
":",
"mgr",
"=",
"SoftLayer",
".",
"DedicatedHostManager",
"(",
"env",
".",
"client",
")",
"hosts",
"=",
"mgr",
".",
"list_instances",
"(",
"cpus",
"=",
"cpu",
",",
"datacenter",
"=",
"datacenter",
",",
"hostname",
"=",
"name",
",",
"memory",
"=",
"memory",
",",
"disk",
"=",
"disk",
",",
"tags",
"=",
"tag",
",",
"mask",
"=",
"columns",
".",
"mask",
"(",
")",
")",
"table",
"=",
"formatting",
".",
"Table",
"(",
"columns",
".",
"columns",
")",
"table",
".",
"sortby",
"=",
"sortby",
"for",
"host",
"in",
"hosts",
":",
"table",
".",
"add_row",
"(",
"[",
"value",
"or",
"formatting",
".",
"blank",
"(",
")",
"for",
"value",
"in",
"columns",
".",
"row",
"(",
"host",
")",
"]",
")",
"env",
".",
"fout",
"(",
"table",
")"
]
| List dedicated host. | [
"List",
"dedicated",
"host",
"."
]
| train | https://github.com/softlayer/softlayer-python/blob/9f181be08cc3668353b05a6de0cb324f52cff6fa/SoftLayer/CLI/dedicatedhost/list.py#L52-L70 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.