def _import(appliances=[],
credentials=[],
timeout=120,
no_check_hostname=False,
Domain=[],
file_in=None,
deployment_policy=None,
dry_run=False,
overwrite_files=True,
overwrite_objects=True,
rewrite_local_ip=True,
source_type='ZIP',
out_dir="tmp/",
web=False):
"""Import a service/object into the specified appliances
Parameters:
* `-a, --appliances`: The hostname(s), ip address(es), environment name(s)
or alias(es) of the appliances you would like to affect. For details
on configuring environments please see the comments in
`environments.conf` located in `$MAST_HOME/etc/default`. For details
on configuring aliases, please see the comments in `hosts.conf` located in
`$MAST_HOME/etc/default`. To pass multiple arguments to this parameter,
use multiple entries of the form `[-a appliance1 [-a appliance2...]]`
* `-c, --credentials`: The credentials to use for authenticating to the
appliances. Should be either one set to use for all appliances
or one set for each appliance. Credentials should be in the form
`username:password`. To pass multiple credentials to this parameter, use
multiple entries of the form `[-c credential1 [-c credential2...]]`.
When referencing multiple appliances with multiple credentials,
there must be a one-to-one correspondence of credentials to appliances:
`[-a appliance1 [-a appliance2...]] [-c credential1 [-c credential2...]]`
If you would prefer to not use plain-text passwords,
you can use the output of `$ mast-system xor <username:password>`.
* `-t, --timeout`: The timeout in seconds to wait for a response from
an appliance for any single request. __NOTE__ Program execution may
halt if a timeout is reached.
* `-n, --no-check-hostname`: If specified SSL verification will be turned
off when sending commands to the appliances.
* `-D. --Domain`: The domain into which the configuration will be imported
* `-f, --file-in`: The file to import into the specified domain. This
__MUST__ match the format specified in source_type
* `-d, --deployment-policy`: The deployment policy to use for the import
(must already exist on the appliances)
* `--dry-run`: Whether to do a dry-run (nothing will be imported)
* `-N, --no-overwrite-files`: If specified, no files will be overwritten
as part of the import
* `--no-overwrite-objects`: If specified, no objects will be overwritten
as part of the import
* `--no-rewrite-local-ip`: If specified, no local ip addresses will be
rewritten as part of the import
* `-s, --source-type`: The type of file to import. Can be "XML" or "ZIP"
* `-o, --out-dir`: The directory to output artifacts generated by this
script
* `-w, --web`: __For Internel Use Only, will be removed in future versions.
DO NOT USE.__"""
logger = make_logger("mast.developer")
t = Timestamp()
check_hostname = not no_check_hostname
env = datapower.Environment(
appliances,
credentials,
timeout,
check_hostname=check_hostname)
msg = "Attempting to import {} to {}".format(file_in, str(env.appliances))
logger.info(msg)
if not web:
print msg
results = {}
out_dir = os.path.join(out_dir, "import_results", t.timestamp)
os.makedirs(out_dir)
for appliance in env.appliances:
if not web:
print appliance.hostname
results[appliance.hostname] = {}
domains = Domain
if "all-domains" in domains:
domains = appliance.domains
for domain in domains:
if not web:
print "\t", domain
kwargs = {
'domain': domain,
'zip_file': file_in,
'deployment_policy': deployment_policy,
'dry_run': dry_run,
'overwrite_files': overwrite_files,
'overwrite_objects': overwrite_objects,
'rewrite_local_ip': rewrite_local_ip,
'source_type': source_type}
resp = appliance.do_import(**kwargs)
results[appliance.hostname][domain] = resp
if not web:
pprint_xml(resp.xml)
logger.debug("Response received: {}".format(str(resp)))
filename = os.path.join(
out_dir,
"{}-{}-import_results.xml".format(
appliance.hostname,
domain
)
)
with open(filename, 'wb') as fout:
fout.write(resp.pretty)
if web:
return util.render_see_download_table(
results, suffix="import"), util.render_history(env)
def export(appliances=[],
credentials=[],
timeout=120,
no_check_hostname=False,
Domain="",
object_name=None,
object_class=None,
comment='',
format='ZIP',
persisted=True,
all_files=True,
referenced_files=True,
referenced_objects=True,
out_dir='tmp',
web=False):
"""Exports a service or object to be used to import into another
domain or appliance
Parameters:
* `-a, --appliances`: The hostname(s), ip address(es), environment name(s)
or alias(es) of the appliances you would like to affect. For details
on configuring environments please see the comments in
`environments.conf` located in `$MAST_HOME/etc/default`. For details
on configuring aliases, please see the comments in `hosts.conf` located in
`$MAST_HOME/etc/default`. To pass multiple arguments to this parameter,
use multiple entries of the form `[-a appliance1 [-a appliance2...]]`
* `-c, --credentials`: The credentials to use for authenticating to the
appliances. Should be either one set to use for all appliances
or one set for each appliance. Credentials should be in the form
`username:password`. To pass multiple credentials to this parameter, use
multiple entries of the form `[-c credential1 [-c credential2...]]`.
When referencing multiple appliances with multiple credentials,
there must be a one-to-one correspondence of credentials to appliances:
`[-a appliance1 [-a appliance2...]] [-c credential1 [-c credential2...]]`
If you would prefer to not use plain-text passwords,
you can use the output of `$ mast-system xor <username:password>`.
* `-t, --timeout`: The timeout in seconds to wait for a response from
an appliance for any single request. __NOTE__ Program execution may
halt if a timeout is reached.
* `-n, --no-check-hostname`: If specified SSL verification will be turned
off when sending commands to the appliances.
* `-D, --Domain`: The domain from which to export service/object
* `-o, --object-name`: The name of the object to export
* `-O, --object-class`: The class of the object to export
* `-C, --comment`: The comment to embed into the export
* `-f, --format`: the format in which to export the configuration. This
can be either "XML" or "ZIP"
* `-N, --no-persisted`: If specified, the running configuration will be
exported as opposed to the persisted configuration
* `--no-all-files`: If specified, the export will not include all files
* `--no-referenced-files`: If specified, the referenced files will not
be included in the export
* `--no-referenced-objects`: If specified, referenced objects will not
be included in the export.
* `--out-dir`: (**NOT NEEDED IN THE WEB GUI**)The directory (local)
in which to save the export
* `-w, --web`: __For Internel Use Only, will be removed in future versions.
DO NOT USE.__"""
logger = make_logger("mast.developer")
t = Timestamp()
if object_name is None or object_class is None:
try:
raise TypeError("Must Provide both object name and object class")
except:
logger.exception("Must Provide both object name and object class")
raise
check_hostname = not no_check_hostname
env = datapower.Environment(
appliances,
credentials,
timeout,
check_hostname=check_hostname)
msg = "Attempting to export {} from {}".format(object_name, str(env.appliances))
logger.info(msg)
kwargs = {
'domain': Domain,
'obj': object_name,
'object_class': object_class,
'comment': comment,
'format': format,
'persisted': persisted,
'all_files': all_files,
'referenced_objects': referenced_objects,
'referenced_files': referenced_files}
results = env.perform_action(
'export',
**kwargs)
for hostname, _export in results.items():
d = os.path.join(out_dir, hostname, t.timestamp)
os.makedirs(d)
extention = format.lower()
filename = os.path.join(d, '%s-%s-%s.%s' % (
t.timestamp,
hostname,
object_name,
extention))
msg = "Writing export of {} from {} to {}".format(object_name, hostname, filename)
logger.debug(msg)
if not web:
print msg
with open(filename, 'wb') as fout:
fout.write(_export)
if web:
return util.render_see_download_table(
results, suffix="export"), util.render_history(env)
def restore_normal_backup(appliances=[],
credentials=[],
timeout=120,
no_check_hostname=False,
file_in=None,
Domain="",
source_type="ZIP",
overwrite_files=True,
overwrite_objects=True,
rewrite_local_ip=True,
deployment_policy=None,
import_domain=True,
reset_domain=True,
dry_run=False,
out_dir="tmp",
web=False):
"""Restores a normal backup to the specified appliances and Domains.
Parameters:
* `-a, --appliances`: The hostname(s), ip address(es), environment name(s)
or alias(es) of the appliances you would like to affect. For details
on configuring environments please see the comments in
`environments.conf` located in `$MAST_HOME/etc/default`. For details
on configuring aliases, please see the comments in `hosts.conf` located in
`$MAST_HOME/etc/default`. To pass multiple arguments to this parameter,
use multiple entries of the form `[-a appliance1 [-a appliance2...]]`
* `-c, --credentials`: The credentials to use for authenticating to the
appliances. Should be either one set to use for all appliances
or one set for each appliance. Credentials should be in the form
`username:password`. To pass multiple credentials to this parameter, use
multiple entries of the form `[-c credential1 [-c credential2...]]`.
When referencing multiple appliances with multiple credentials,
there must be a one-to-one correspondence of credentials to appliances:
`[-a appliance1 [-a appliance2...]] [-c credential1 [-c credential2...]]`
If you would prefer to not use plain-text passwords,
you can use the output of `$ mast-system xor <username:password>`.
* `-t, --timeout`: The timeout in seconds to wait for a response from
an appliance for any single request. __NOTE__ Program execution may
halt if a timeout is reached.
* `-n, --no-check-hostname`: If specified SSL verification will be turned
off when sending commands to the appliances.
* `-f, --file-in`: The backup file which will be restored. This must be in the
format specified in source_type
* `-D, --Domain`: The domain to which to restore the backup
* `-s, --source-type`: The type of backup, must be either "ZIP" or "XML"
* `-N, --no-overwrite-files`: Whether to overwrite files when restoring
the backup
* `--no-overwrite-objects`: Whether to overwrite objects when restoring
the backup
* `--no-rewrite-local-ip`: Whether to rewrite the local IP Addresses
* `-d, --deployment-policy`: The deployment policy to apply when restoring
the backup
* `--no-import-domain`: Whether we are importing a domain
* `--no-reset-domain`: Whether to reset the domain
* `--dry-run`: Whether this should be a dry-run
* `-o, --out_dir`: (NOT NEEDED IN WEB GUI) The directory (local) where you would
want all of the files generated by the restore to be placed
* `-w, --web`: __For Internel Use Only, will be removed in future versions.
DO NOT USE.__"""
logger = make_logger("mast.backups")
t = Timestamp()
check_hostname = not no_check_hostname
env = datapower.Environment(appliances,
credentials,
timeout,
check_hostname=check_hostname)
logger.info(
"Attempting to restore normal backup on {} in {} domain".format(
str(env.appliances), Domain))
kwargs = {
"file_in": file_in,
"source_type": source_type,
"domain": Domain,
"overwrite_files": overwrite_files,
"overwrite_objects": overwrite_objects,
"rewrite_local_ip": rewrite_local_ip,
"deployment_policy": deployment_policy,
"import_domain": import_domain,
"reset_domain": reset_domain,
"dry_run": dry_run
}
resp = env.perform_action("restore_normal_backup", **kwargs)
logger.debug("Responses received {}".format(str(resp)))
out_dir = os.path.join(out_dir, "restore_normal_backup", t.timestamp)
os.makedirs(out_dir)
for host, r in resp.items():
filename = os.path.join(
out_dir, "{}-{}-{}-results.xml".format(t.timestamp, host, Domain))
with open(filename, 'wb') as fout:
fout.write(r.pretty)
if web:
return util.render_see_download_table(resp), util.render_history(env)
def export_certs(appliances=[],
credentials=[],
timeout=120,
no_check_hostname=False,
domains=[],
out_dir="tmp",
delay=0.5,
web=False):
"""Export all CryptoCertificate objects which are up and enabled
from the specified domains on the specified appliances in PEM format
and download them to `out-dir`
Output:
Downloaded files
Parameters:
* `-a, --appliances`: The hostname(s), ip address(es), environment name(s)
or alias(es) of the appliances you would like to affect. For details
on configuring environments please see the comments in
`environments.conf` located in `$MAST_HOME/etc/default`. For details
on configuring aliases, please see the comments in `hosts.conf` located in
`$MAST_HOME/etc/default`. To pass multiple arguments to this parameter,
use multiple entries of the form `[-a appliance1 [-a appliance2...]]`
* `-c, --credentials`: The credentials to use for authenticating to the
appliances. Should be either one set to use for all appliances
or one set for each appliance. Credentials should be in the form
`username:password`. To pass multiple credentials to this parameter, use
multiple entries of the form `[-c credential1 [-c credential2...]]`.
When referencing multiple appliances with multiple credentials,
there must be a one-to-one correspondence of credentials to appliances:
`[-a appliance1 [-a appliance2...]] [-c credential1 [-c credential2...]]`
If you would prefer to not use plain-text passwords,
you can use the output of `$ mast-system xor <username:password>`.
* `-t, --timeout`: The timeout in seconds to wait for a response from
an appliance for any single request. __NOTE__ Program execution may
halt if a timeout is reached.
* `-n, --no-check-hostname`: If specified SSL verification will be turned
off when sending commands to the appliances.
* `-d, --domains`: The domains to audit, to audit all domains, provide
`all-domains`, to specify multiple domains use multiple entries of the
form `[-d domain1 [-d domain2...]]`.
* `-o, --out-dir`: The directory to which to download the certificates.
* `-D, --delay`: The amount of time in seconds to wait between exporting each
certificate. If you are experiencing intermitten `AuthenticationFailure`s,
it is a good idea to increase this parameter.
* `-w, --web`: __For Internel Use Only, will be removed in future versions.
DO NOT USE.__"""
logger = make_logger("export-certs")
check_hostname = not no_check_hostname
env = datapower.Environment(appliances,
credentials,
timeout,
check_hostname=check_hostname)
for appliance in env.appliances:
logger.info("Checking appliance {}".format(appliance.hostname))
if not web:
print appliance.hostname
_domains = domains
if "all-domains" in domains:
_domains = appliance.domains
for domain in _domains:
logger.info("In domain {}".format(domain))
if not web:
print "\t", domain
# Get a list of all certificates in this domain
config = appliance.get_config("CryptoCertificate", domain=domain)
certs = [x for x in config.xml.findall(datapower.CONFIG_XPATH)]
# Filter out disabled objects because the results won't change,
# but we will perform less network traffic
certs = filter(
lambda x: x.find("mAdminState").text == "enabled",
certs)
if not certs:
continue
# Create a directory structure $out_dir/hostname/domain
dir_name = os.path.join(out_dir, appliance.hostname, domain)
if not os.path.exists(dir_name):
os.makedirs(dir_name)
for cert in certs:
logger.info("Exporting cert {}".format(cert))
# Get filename as it will appear locally
filename = cert.find("Filename").text
out_file = re.sub(r":[/]*", "/", filename)
out_file = out_file.split("/")
out_file = os.path.join(dir_name, *out_file)
# extract directory name as it will appear locally
_out_dir = out_file.split(os.path.sep)[:-1]
_out_dir = os.path.join(*_out_dir)
# Create the directory if it doesn't exist
if not os.path.exists(_out_dir):
os.makedirs(_out_dir)
name = cert.get("name")
if not web:
print "\t\t", name
export = appliance.CryptoExport(domain=domain,
ObjectType="cert",
ObjectName=name,
OutputFilename=name)
# TODO: Test export and handle failure
logger.info("Finished exporting cert {}".format(cert))
try:
logger.info(
"Retrieving file temporary:///{}".format(name))
cert = appliance.getfile(domain,
"temporary:///{}".format(name))
logger.info(
"Finished retrieving file temporary:///{}".format(
name))
logger.info(
"Attempting to delete file temporary:///{}".format(
name))
appliance.DeleteFile(domain=domain,
File="temporary:///{}".format(name))
logger.info(
"Finished deleting file temporary:///{}".format(name))
except:
logger.exception("An unhandled exception has occurred")
if not web:
print "SKIPPING CERT"
continue
cert = etree.fromstring(cert)
with open(out_file, "w") as fout:
_contents = insert_newlines(cert.find("certificate").text)
contents = "{}\n{}\n{}\n".format(
"-----BEGIN CERTIFICATE-----",
_contents,
"-----END CERTIFICATE-----")
fout.write(contents)
if web:
return (util.render_see_download_table({k.hostname: "" for k in env.appliances},
"export-certs"),
util.render_history(env))
def get_file(appliances=[],
credentials=[],
timeout=120,
no_check_hostname=False,
location=None,
Domain='default',
out_dir='tmp',
web=False):
"""Retrieves a file from the specified appliances
Parameters:
* `-a, --appliances`: The hostname(s), ip address(es), environment name(s)
or alias(es) of the appliances you would like to affect. For details
on configuring environments please see the comments in
`environments.conf` located in `$MAST_HOME/etc/default`. For details
on configuring aliases, please see the comments in `hosts.conf` located in
`$MAST_HOME/etc/default`. To pass multiple arguments to this parameter,
use multiple entries of the form `[-a appliance1 [-a appliance2...]]`
* `-c, --credentials`: The credentials to use for authenticating to the
appliances. Should be either one set to use for all appliances
or one set for each appliance. Credentials should be in the form
`username:password`. To pass multiple credentials to this parameter, use
multiple entries of the form `[-c credential1 [-c credential2...]]`.
When referencing multiple appliances with multiple credentials,
there must be a one-to-one correspondence of credentials to appliances:
`[-a appliance1 [-a appliance2...]] [-c credential1 [-c credential2...]]`
If you would prefer to not use plain-text passwords,
you can use the output of `$ mast-system xor <username:password>`.
* `-t, --timeout`: The timeout in seconds to wait for a response from
an appliance for any single request. __NOTE__ Program execution may
halt if a timeout is reached.
* `-n, --no-check-hostname`: If specified SSL verification will be turned
off when sending commands to the appliances.
* `-l, --location`: The location of the file (on DataPower) you would
like to get
* `-D, --Domain`: The domain from which to get the file
* `-o, --out-dir`: (NOT NEEDED IN THE WEB GUI)The directory you would like to
save the file to
* `-w, --web`: __For Internel Use Only, will be removed in future versions.
DO NOT USE.__"""
t = Timestamp()
check_hostname = not no_check_hostname
env = datapower.Environment(
appliances,
credentials,
timeout,
check_hostname=check_hostname)
kwargs = {'domain': Domain, 'filename': location}
responses = env.perform_async_action('getfile', **kwargs)
if not os.path.exists(out_dir) or not os.path.isdir(out_dir):
os.makedirs(out_dir)
for hostname, fin in list(responses.items()):
filename = location.split('/')[-1]
filename = os.path.join(
out_dir,
'%s-%s-%s' % (hostname, t.timestamp, filename))
with open(filename, 'wb') as fout:
fout.write(fin)
if web:
return util.render_see_download_table(
responses, suffix="get_file"), util.render_history(env)
def export(appliances=[],
credentials=[],
timeout=120,
no_check_hostname=False,
Domain="",
object_name=None,
object_class=None,
comment='',
format='ZIP',
persisted=True,
all_files=True,
referenced_files=True,
referenced_objects=True,
out_dir='tmp',
web=False):
"""Exports a service or object to be used to import into another
domain or appliance
Parameters:
* `-a, --appliances`: The hostname(s), ip address(es), environment name(s)
or alias(es) of the appliances you would like to affect. For details
on configuring environments please see the comments in
`environments.conf` located in `$MAST_HOME/etc/default`. For details
on configuring aliases, please see the comments in `hosts.conf` located in
`$MAST_HOME/etc/default`. To pass multiple arguments to this parameter,
use multiple entries of the form `[-a appliance1 [-a appliance2...]]`
* `-c, --credentials`: The credentials to use for authenticating to the
appliances. Should be either one set to use for all appliances
or one set for each appliance. Credentials should be in the form
`username:password`. To pass multiple credentials to this parameter, use
multiple entries of the form `[-c credential1 [-c credential2...]]`.
When referencing multiple appliances with multiple credentials,
there must be a one-to-one correspondence of credentials to appliances:
`[-a appliance1 [-a appliance2...]] [-c credential1 [-c credential2...]]`
If you would prefer to not use plain-text passwords,
you can use the output of `$ mast-system xor <username:password>`.
* `-t, --timeout`: The timeout in seconds to wait for a response from
an appliance for any single request. __NOTE__ Program execution may
halt if a timeout is reached.
* `-n, --no-check-hostname`: If specified SSL verification will be turned
off when sending commands to the appliances.
* `-D, --Domain`: The domain from which to export service/object
* `-o, --object-name`: The name of the object to export
* `-O, --object-class`: The class of the object to export
* `-C, --comment`: The comment to embed into the export
* `-f, --format`: the format in which to export the configuration. This
can be either "XML" or "ZIP"
* `-N, --no-persisted`: If specified, the running configuration will be
exported as opposed to the persisted configuration
* `--no-all-files`: If specified, the export will not include all files
* `--no-referenced-files`: If specified, the referenced files will not
be included in the export
* `--no-referenced-objects`: If specified, referenced objects will not
be included in the export.
* `--out-dir`: (**NOT NEEDED IN THE WEB GUI**)The directory (local)
in which to save the export
* `-w, --web`: __For Internel Use Only, will be removed in future versions.
DO NOT USE.__"""
logger = make_logger("mast.developer")
t = Timestamp()
if object_name is None or object_class is None:
try:
raise TypeError("Must Provide both object name and object class")
except:
logger.exception("Must Provide both object name and object class")
raise
check_hostname = not no_check_hostname
env = datapower.Environment(
appliances,
credentials,
timeout,
check_hostname=check_hostname)
msg = "Attempting to export {} from {}".format(object_name, str(env.appliances))
logger.info(msg)
kwargs = {
'domain': Domain,
'obj': object_name,
'object_class': object_class,
'comment': comment,
'format': format,
'persisted': persisted,
'all_files': all_files,
'referenced_objects': referenced_objects,
'referenced_files': referenced_files}
results = env.perform_action(
'export',
**kwargs)
for hostname, _export in results.items():
d = os.path.join(out_dir, hostname, t.timestamp)
os.makedirs(d)
extention = format.lower()
filename = os.path.join(d, '%s-%s-%s.%s' % (
t.timestamp,
hostname,
object_name,
extention))
msg = "Writing export of {} from {} to {}".format(object_name, hostname, filename)
logger.debug(msg)
if not web:
print msg
with open(filename, 'wb') as fout:
fout.write(_export)
if web:
return util.render_see_download_table(
results, suffix="export"), util.render_history(env)
def _import(appliances=[],
credentials=[],
timeout=120,
no_check_hostname=False,
Domain=[],
file_in=None,
deployment_policy=None,
deployment_policy_variables=None,
dry_run=False,
overwrite_files=True,
overwrite_objects=True,
rewrite_local_ip=True,
source_type='ZIP',
out_dir="tmp/",
web=False):
"""Import a service/object into the specified appliances
Parameters:
* `-a, --appliances`: The hostname(s), ip address(es), environment name(s)
or alias(es) of the appliances you would like to affect. For details
on configuring environments please see the comments in
`environments.conf` located in `$MAST_HOME/etc/default`. For details
on configuring aliases, please see the comments in `hosts.conf` located in
`$MAST_HOME/etc/default`. To pass multiple arguments to this parameter,
use multiple entries of the form `[-a appliance1 [-a appliance2...]]`
* `-c, --credentials`: The credentials to use for authenticating to the
appliances. Should be either one set to use for all appliances
or one set for each appliance. Credentials should be in the form
`username:password`. To pass multiple credentials to this parameter, use
multiple entries of the form `[-c credential1 [-c credential2...]]`.
When referencing multiple appliances with multiple credentials,
there must be a one-to-one correspondence of credentials to appliances:
`[-a appliance1 [-a appliance2...]] [-c credential1 [-c credential2...]]`
If you would prefer to not use plain-text passwords,
you can use the output of `$ mast-system xor <username:password>`.
* `-t, --timeout`: The timeout in seconds to wait for a response from
an appliance for any single request. __NOTE__ Program execution may
halt if a timeout is reached.
* `-n, --no-check-hostname`: If specified SSL verification will be turned
off when sending commands to the appliances.
* `-D. --Domain`: The domain into which the configuration will be imported
* `-f, --file-in`: The file to import into the specified domain. This
__MUST__ match the format specified in source_type
* `-d, --deployment-policy`: The deployment policy to use for the import
(must already exist on the appliances)
* `--dry-run`: Whether to do a dry-run (nothing will be imported)
* `-N, --no-overwrite-files`: If specified, no files will be overwritten
as part of the import
* `--no-overwrite-objects`: If specified, no objects will be overwritten
as part of the import
* `--no-rewrite-local-ip`: If specified, no local ip addresses will be
rewritten as part of the import
* `-s, --source-type`: The type of file to import. Can be "XML" or "ZIP"
* `-o, --out-dir`: The directory to output artifacts generated by this
script
* `-w, --web`: __For Internel Use Only, will be removed in future versions.
DO NOT USE.__"""
logger = make_logger("mast.developer")
t = Timestamp()
check_hostname = not no_check_hostname
env = datapower.Environment(
appliances,
credentials,
timeout,
check_hostname=check_hostname)
msg = "Attempting to import {} to {}".format(file_in, str(env.appliances))
logger.info(msg)
if not web:
print msg
results = {}
out_dir = os.path.join(out_dir, "import_results", t.timestamp)
os.makedirs(out_dir)
for appliance in env.appliances:
if not web:
print appliance.hostname
results[appliance.hostname] = {}
domains = Domain
if "all-domains" in domains:
domains = appliance.domains
for domain in domains:
if not web:
print "\t", domain
kwargs = {
'domain': domain,
'zip_file': file_in,
'deployment_policy': deployment_policy,
'deployment_policy_variables': deployment_policy_variables,
'dry_run': dry_run,
'overwrite_files': overwrite_files,
'overwrite_objects': overwrite_objects,
'rewrite_local_ip': rewrite_local_ip,
'source_type': source_type}
resp = appliance.do_import(**kwargs)
results[appliance.hostname][domain] = resp
if not web:
pprint_xml(resp.xml)
logger.debug("Response received: {}".format(str(resp)))
filename = os.path.join(
out_dir,
"{}-{}-import_results.xml".format(
appliance.hostname,
domain
)
)
with open(filename, 'wb') as fout:
fout.write(resp.pretty)
if web:
return util.render_see_download_table(
results, suffix="import"), util.render_history(env)
def restore_normal_backup(appliances=[],
credentials=[],
timeout=120,
no_check_hostname=False,
file_in=None,
Domain="",
source_type="ZIP",
overwrite_files=True,
overwrite_objects=True,
rewrite_local_ip=True,
deployment_policy=None,
import_domain=True,
reset_domain=True,
dry_run=False,
out_dir="tmp",
web=False):
"""Restores a normal backup to the specified appliances and Domains.
Parameters:
* `-a, --appliances`: The hostname(s), ip address(es), environment name(s)
or alias(es) of the appliances you would like to affect. For details
on configuring environments please see the comments in
`environments.conf` located in `$MAST_HOME/etc/default`. For details
on configuring aliases, please see the comments in `hosts.conf` located in
`$MAST_HOME/etc/default`. To pass multiple arguments to this parameter,
use multiple entries of the form `[-a appliance1 [-a appliance2...]]`
* `-c, --credentials`: The credentials to use for authenticating to the
appliances. Should be either one set to use for all appliances
or one set for each appliance. Credentials should be in the form
`username:password`. To pass multiple credentials to this parameter, use
multiple entries of the form `[-c credential1 [-c credential2...]]`.
When referencing multiple appliances with multiple credentials,
there must be a one-to-one correspondence of credentials to appliances:
`[-a appliance1 [-a appliance2...]] [-c credential1 [-c credential2...]]`
If you would prefer to not use plain-text passwords,
you can use the output of `$ mast-system xor <username:password>`.
* `-t, --timeout`: The timeout in seconds to wait for a response from
an appliance for any single request. __NOTE__ Program execution may
halt if a timeout is reached.
* `-n, --no-check-hostname`: If specified SSL verification will be turned
off when sending commands to the appliances.
* `-f, --file-in`: The backup file which will be restored. This must be in the
format specified in source_type
* `-D, --Domain`: The domain to which to restore the backup
* `-s, --source-type`: The type of backup, must be either "ZIP" or "XML"
* `-N, --no-overwrite-files`: Whether to overwrite files when restoring
the backup
* `--no-overwrite-objects`: Whether to overwrite objects when restoring
the backup
* `--no-rewrite-local-ip`: Whether to rewrite the local IP Addresses
* `-d, --deployment-policy`: The deployment policy to apply when restoring
the backup
* `--no-import-domain`: Whether we are importing a domain
* `--no-reset-domain`: Whether to reset the domain
* `--dry-run`: Whether this should be a dry-run
* `-o, --out_dir`: (NOT NEEDED IN WEB GUI) The directory (local) where you would
want all of the files generated by the restore to be placed
* `-w, --web`: __For Internel Use Only, will be removed in future versions.
DO NOT USE.__"""
logger = make_logger("mast.backups")
t = Timestamp()
check_hostname = not no_check_hostname
env = datapower.Environment(
appliances,
credentials,
timeout,
check_hostname=check_hostname)
logger.info(
"Attempting to restore normal backup on {} in {} domain".format(
str(env.appliances), Domain))
kwargs = {
"file_in": file_in,
"source_type": source_type,
"domain": Domain,
"overwrite_files": overwrite_files,
"overwrite_objects": overwrite_objects,
"rewrite_local_ip": rewrite_local_ip,
"deployment_policy": deployment_policy,
"import_domain": import_domain,
"reset_domain": reset_domain,
"dry_run": dry_run}
resp = env.perform_action("restore_normal_backup", **kwargs)
logger.debug("Responses received {}".format(str(resp)))
out_dir = os.path.join(out_dir, "restore_normal_backup", t.timestamp)
os.makedirs(out_dir)
for host, r in resp.items():
filename = os.path.join(out_dir, "{}-{}-{}-results.xml".format(
t.timestamp,
host,
Domain))
with open(filename, 'wb') as fout:
fout.write(r.pretty)
if web:
return util.render_see_download_table(resp), util.render_history(env)
def get_file(appliances=[],
credentials=[],
timeout=120,
no_check_hostname=False,
location=None,
Domain='default',
out_dir='tmp',
web=False):
"""Retrieves a file from the specified appliances
Parameters:
* `-a, --appliances`: The hostname(s), ip address(es), environment name(s)
or alias(es) of the appliances you would like to affect. For details
on configuring environments please see the comments in
`environments.conf` located in `$MAST_HOME/etc/default`. For details
on configuring aliases, please see the comments in `hosts.conf` located in
`$MAST_HOME/etc/default`. To pass multiple arguments to this parameter,
use multiple entries of the form `[-a appliance1 [-a appliance2...]]`
* `-c, --credentials`: The credentials to use for authenticating to the
appliances. Should be either one set to use for all appliances
or one set for each appliance. Credentials should be in the form
`username:password`. To pass multiple credentials to this parameter, use
multiple entries of the form `[-c credential1 [-c credential2...]]`.
When referencing multiple appliances with multiple credentials,
there must be a one-to-one correspondence of credentials to appliances:
`[-a appliance1 [-a appliance2...]] [-c credential1 [-c credential2...]]`
If you would prefer to not use plain-text passwords,
you can use the output of `$ mast-system xor <username:password>`.
* `-t, --timeout`: The timeout in seconds to wait for a response from
an appliance for any single request. __NOTE__ Program execution may
halt if a timeout is reached.
* `-n, --no-check-hostname`: If specified SSL verification will be turned
off when sending commands to the appliances.
* `-l, --location`: The location of the file (on DataPower) you would
like to get
* `-D, --Domain`: The domain from which to get the file
* `-o, --out-dir`: (NOT NEEDED IN THE WEB GUI)The directory you would like to
save the file to
* `-w, --web`: __For Internel Use Only, will be removed in future versions.
DO NOT USE.__"""
t = Timestamp()
check_hostname = not no_check_hostname
env = datapower.Environment(appliances,
credentials,
timeout,
check_hostname=check_hostname)
kwargs = {'domain': Domain, 'filename': location}
responses = env.perform_async_action('getfile', **kwargs)
if not os.path.exists(out_dir) or not os.path.isdir(out_dir):
os.makedirs(out_dir)
for hostname, fin in list(responses.items()):
filename = location.split('/')[-1]
filename = os.path.join(out_dir,
'%s-%s-%s' % (hostname, t.timestamp, filename))
with open(filename, 'wb') as fout:
fout.write(fin)
if web:
return util.render_see_download_table(
responses, suffix="get_file"), util.render_history(env)
