def definearguments(self, customparser):
""" Wrapper function for new command main function
:param customparser: command line input
:type customparser: parser.
"""
if not customparser:
return
add_login_arguments_group(customparser)
customparser.add_argument(
'--controller',
dest='controller',
help="""Use this flag to select the corresponding controller """ \
"""using either the slot number or index.""",
default=None,
)
customparser.add_argument(
'--all',
dest='all',
help="""Use this flag to delete all logical drives on a """ \
"""controller.""",
action="store_true",
default=False,
)
customparser.add_argument(
'--force',
dest='force',
help="""Use this flag to override the "are you sure?" text when """ \
"""deleting a logical drive.""",
action="store_true",
default=False,
)
def definearguments(self, customparser):
""" Wrapper function for new command main function
:param customparser: command line input
:type customparser: parser.
"""
if not customparser:
return
add_login_arguments_group(customparser)
customparser.add_argument(
'--reboot',
dest='reboot',
help="Use this flag to perform a reboot command function after "\
"completion of operations. 'REBOOT' is a replaceable parameter "\
"that can have multiple values. For help with parameters and "\
"descriptions regarding the reboot flag, run help reboot.",
default=None,
)
customparser.add_argument(
'--poweron',
dest='poweron',
action="store_true",
help="""Use this flag to set power on password instead""",
default=None,
)
def definearguments(self, customparser):
""" Wrapper function for new command main function
:param customparser: command line input
:type customparser: parser.
"""
if not customparser:
return
add_login_arguments_group(customparser)
customparser.add_argument(
'--nomonitor',
dest='nomonitor',
help="Optionally include this flag to skip monitoring of the one button erase process "\
"and simply trigger the operation.",
action="store_true",
default=False,
)
customparser.add_argument(
'--confirm',
dest='confirm',
help="Optionally include this flag to skip the confirmation prompt before starting One"\
" Button Erase and begin the operation.",
action="store_true",
default=False,
)
def definearguments(self, customparser):
""" Wrapper function for new command main function
:param customparser: command line input
:type customparser: parser.
"""
if not customparser:
return
add_login_arguments_group(customparser)
customparser.add_argument(
'-f',
'--filename',
dest='filename',
help="Use this flag to specify which backup file to restore. By "\
"default the commmand will try to find a .bak file in the current "\
"working directory.",
action="append",
default=None,
)
customparser.add_argument(
'--filepass',
dest='fpass',
help="Optionally use the provided password when creating the "\
"backup file. The same password must be used for restoring.",
default=None,
)
def definearguments(self, customparser):
""" Wrapper function for new command main function
:param customparser: command line input
:type customparser: parser.
"""
if not customparser:
return
add_login_arguments_group(customparser)
customparser.add_argument(
'--controller',
dest='controller',
help="""Use this flag to select the corresponding controller """ \
"""using either the slot number or index.""",
default=None,
)
customparser.add_argument(
'--reboot',
dest='reboot',
help="""Include this flag to perform a coldboot command """ \
"""function after completion of operations and monitor """ \
"""sanitization.""",
action="store_true",
default=False,
)
customparser.add_argument(
'--all',
dest='all',
help="""Use this flag to sanitize all physical drives on a """ \
"""controller.""",
action="store_true",
default=False,
)
def definearguments(self, customparser):
""" Wrapper function for download command main function
:param customparser: command line input
:type customparser: parser.
"""
if not customparser:
return
add_login_arguments_group(customparser)
'''
customparser.add_argument(
'--logout',
dest='logout',
action="store_true",
help="Optionally include the logout flag to log out of the"\
" server after this command is completed. Using this flag when"\
" not logged in will have no effect.",
default=None,
)
'''
customparser.add_argument(
'--outdir',
dest='outdir',
help="""Output directory for saving the file.""",
default="",
)
def definearguments(self, customparser):
""" Wrapper function for new command main function
:param customparser: command line input
:type customparser: parser.
"""
if not customparser:
return
add_login_arguments_group(customparser, full=True)
customparser.add_argument(
'--refresh',
dest='ref',
action="store_true",
help="Optionally reload the data of selected type and clear "\
"patches from current selection.",
default=False,
)
customparser.add_argument(
'--biospassword',
dest='biospassword',
help="Select this flag to input a BIOS password. Include this"\
" flag if second-level BIOS authentication is needed for the"\
" command to execute. This option is only used on Gen 9 systems.",
default=None,
)
def definearguments(self, customparser):
""" Wrapper function for new command main function
:param customparser: command line input
:type customparser: parser.
"""
if not customparser:
return
add_login_arguments_group(customparser)
customparser.add_argument(
'--forceupload',
dest='forceupload',
action="store_true",
help='Add this flag to force upload firmware with the same name '\
'already on the repository.',
default=False,
)
customparser.add_argument(
'--ignorechecks',
dest='ignore',
action="store_true",
help='Add this flag to ignore all checks to the taskqueue '\
'before attempting to process the .fwpkg file.',
default=False,
)
customparser.add_argument(
'--tpmover',
dest='tover',
action="store_true",
help="If set then the TPMOverrideFlag is passed in on the "\
"associated flash operations",
default=False
)
def definearguments(self, customparser):
""" Define command line argument for the upload command
:param customparser: command line input
:type customparser: parser.
"""
if not customparser:
return
add_login_arguments_group(customparser)
customparser.add_argument(
'-j',
'--json',
dest='json',
action="store_true",
help="Optionally include this flag if you wish to change the"\
" displayed output to JSON format. Preserving the JSON data"\
" structure makes the information easier to parse.",
default=False
)
customparser.add_argument(
'--component',
dest='component',
help="""Component or binary file path to upload to the update service.""",
default="",
)
customparser.add_argument(
'--compsig',
dest='componentsig',
help='Component signature file path needed by iLO to authenticate the '\
'component file. If not provided will try to find the ' \
'signature file from component file path.',
default="",
)
customparser.add_argument(
'--forceupload',
dest='forceupload',
action="store_true",
help='Add this flag to force upload components with the same name '\
'already on the repository.',
default=False,
)
customparser.add_argument(
'--update_repository',
dest='update_repository',
action="store_false",
help='Add this flag to skip uploading component/binary to the '\
'iLO Repository.',
default=True,
)
customparser.add_argument(
'--update_target',
dest='update_target',
action="store_true",
help='Add this flag if you wish to flash the component/binary.',
default=False,
)
def definearguments(self, customparser):
""" Wrapper function for new command main function
:param customparser: command line input
:type customparser: parser.
"""
if not customparser:
return
add_login_arguments_group(customparser)
customparser.add_argument(
'path',
help="Path to the JSON file containing the data to be patched.",
)
customparser.add_argument(
'--response',
dest='response',
action="store_true",
help="Use this flag to return the iLO response body.",
default=False)
customparser.add_argument(
'--getheaders',
dest='getheaders',
action="store_true",
help="Use this flag to return the iLO response headers.",
default=False)
customparser.add_argument(
'--headers',
dest='headers',
help="Use this flag to add extra headers to the request."\
"\t\t\t\t\t Usage: --headers=HEADER:VALUE,HEADER:VALUE",
default=None,
)
customparser.add_argument(
'--silent',
dest='silent',
action="store_true",
help="""Use this flag to silence responses""",
default=False,
)
customparser.add_argument(
'--biospassword',
dest='biospassword',
help="Select this flag to input a BIOS password. Include this"\
" flag if second-level BIOS authentication is needed for the"\
" command to execute. This option is only used on Gen 9 systems.",
default=None,
)
customparser.add_argument(
'--service',
dest='service',
action="store_true",
help=
"""Use this flag to enable service mode and increase the function speed""",
default=False,
)
def definearguments(self, customparser):
""" Wrapper function for new command main function
:param customparser: command line input
:type customparser: parser.
"""
if not customparser:
return
add_login_arguments_group(customparser)
customparser.add_argument(
'path',
help="Uri on iLO to be deleted.",
)
customparser.add_argument(
'--response',
dest='response',
action="store_true",
help="Use this flag to return the iLO response body.",
default=False)
customparser.add_argument(
'--getheaders',
dest='getheaders',
action="store_true",
help="Use this flag to return the iLO response headers.",
default=False)
customparser.add_argument(
'--headers',
dest='headers',
help="Use this flag to add extra headers to the request."\
"\t\t\t\t\t Usage: --headers=HEADER:VALUE,HEADER:VALUE",
default=None,
)
customparser.add_argument(
'--silent',
dest='silent',
action="store_true",
help="""Use this flag to silence responses""",
default=False,
)
customparser.add_argument(
'--service',
dest='service',
action="store_true",
help=
"""Use this flag to enable service mode and increase the function speed""",
default=False,
)
customparser.add_argument(
'--expand',
dest='expand',
action="store_true",
help="""Use this flag to expand the path specified using the """\
"""expand notation '?$expand=.'""",
default=False,
)
def definearguments(self, customparser):
""" Wrapper function for new command main function
:param customparser: command line input
:type customparser: parser.
"""
if not customparser:
return
add_login_arguments_group(customparser)
def definearguments(self, customparser):
""" Wrapper function for new command main function
:param customparser: command line input
:type customparser: parser.
"""
if not customparser:
return
add_login_arguments_group(customparser)
customparser.add_argument(
'-r',
'--running',
dest='running_jobs',
default=False,
action="store_true",
help=
"""Show status of the currently running or last job executed""",
)
customparser.add_argument(
'-D',
'--diags',
help=
"""Get result of last HVT (diagnostics) run as part of an ipprofile job""",
default=False,
action='store_true',
dest='get_hvt')
customparser.add_argument(
'-f',
'--filename',
dest='filename',
help="""Write results to the specified file.""",
action="append",
default=None,
)
customparser.add_argument(
'-d',
'--delete',
dest='del_key',
action='append',
help='Look for the key or keys in the ipprofile manager and delete',
default=None,
)
customparser.add_argument(
'-s',
'--start',
dest='start_ip',
help=
'Copies the specified ip profile into the job queue and starts it',
default=None,
)
def definearguments(self, customparser):
""" Wrapper function for new command main function
:param customparser: command line input
:type customparser: parser.
"""
if not customparser:
return
add_login_arguments_group(customparser)
customparser.add_argument(
'-f',
'--filename',
dest='filename',
help="Use this flag if you wish to use a different"\
" filename than the default one. The default filename is" \
" clone.json.",
default=None,
)
customparser.add_argument(
'--ssocert',
dest='ssocert',
help="Use this flag during iloclone save if you wish to import a SSO"\
" certificate to the server to be cloned. Add the sso cert file or "\
"URL to be used to the working directory before running clone load.",
default=None,
)
customparser.add_argument(
'--httpscert',
dest='httpscert',
help="Use this flag during iloclone save if you wish to import a SSO"\
" certificate to the server to be cloned. Add the https cert file to"\
" be used to the working directory before running clone load.",
default=None,
)
customparser.add_argument(
'--uniqueitemoverride',
dest='uniqueoverride',
action='store_false',
help="Override the measures stopping the tool from writing "\
"over items that are system unique.",
default=True
)
customparser.add_argument(
'--encryption',
dest='encryption',
help="Optionally include this flag to encrypt/decrypt a file "\
"using the key provided.",
default=None
)
def definearguments(self, customparser):
""" Wrapper function for new command main function
:param customparser: command line input
:type customparser: parser.
"""
if not customparser:
return
add_login_arguments_group(customparser, full=True)
customparser.add_argument(
'--selector',
dest='selector',
help="Optionally include this flag to select a type to run"\
" the current command on. Use this flag when you wish to"\
" select a type without entering another command, or if you"\
" wish to work with a type that is different from the one"\
" you currently have selected.",
default=None,
)
customparser.add_argument(
'-j',
'--json',
dest='json',
action="store_true",
help="Optionally include this flag if you wish to change the"\
" displayed output to JSON format. Preserving the JSON data"\
" structure makes the information easier to parse.",
default=False
)
customparser.add_argument(
'--logout',
dest='logout',
action="store_true",
help="Optionally include the logout flag to log out of the"\
" server after this command is completed. Using this flag when"\
" not logged in will have no effect",
default=None,
)
customparser.add_argument(
'--latestschema',
dest='latestschema',
action='store_true',
help="Optionally use the latest schema instead of the one "\
"requested by the file. Note: May cause errors in some data "\
"retrieval due to difference in schema versions.",
default=None
)
def definearguments(self, customparser):
""" Wrapper function for new command main function
:param customparser: command line input
:type customparser: parser.
"""
if not customparser:
return
add_login_arguments_group(customparser)
customparser.add_argument(
'--controller',
dest='controller',
help="Use this flag to select the corresponding controller "\
"using either the slot number or index.""",
default=None,
)
customparser.add_argument(
'--physicaldrives',
dest='physicaldrives',
action="store_true",
help="""Use this flag to return the physical drives for the """
"""controller selected.""",
default=None,
)
customparser.add_argument(
'--logicaldrives',
dest='logicaldrives',
action="store_true",
help="""Use this flag to return the logical drives for the """
"""controller selected.""",
default=None,
)
customparser.add_argument(
'--pdrive',
dest='pdrive',
help="""Use this flag to select the corresponding physical disk.""",
default=None,
)
customparser.add_argument(
'--ldrive',
dest='ldrive',
help="""Use this flag to select the corresponding logical disk.""",
default=None,
)
def definearguments(self, customparser):
""" Wrapper function for new command main function
:param customparser: command line input
:type customparser: parser.
"""
if not customparser:
return
add_login_arguments_group(customparser)
customparser.add_argument(
'--reboot',
dest='reboot',
help="Use this flag to perform a reboot command function after"\
" completion of operations. For help with parameters and"\
" descriptions regarding the reboot flag, run help reboot.",
default=None,
)
customparser.add_argument(
'--remove',
dest='removevm',
action="store_true",
help="Use this flag to remove the media from the selection.",
default=False
)
customparser.add_argument(
'--bootnextreset',
dest='bootnextreset',
action="store_true",
help="Use this flag if you wish to boot from the image on "\
"next server reboot. NOTE: The image will be ejected "\
"automatically on the second server reboot so that the server "\
"does not boot to this image twice.",
default=False
)
customparser.add_argument(
'-j',
'--json',
dest='json',
action="store_true",
help="Optionally include this flag if you wish to change the"\
" displayed output to JSON format. Preserving the JSON data"\
" structure makes the information easier to parse.",
default=False
)
def definearguments(self, customparser):
""" Wrapper function for new command main function
:param customparser: command line input
:type customparser: parser.
"""
if not customparser:
return
add_login_arguments_group(customparser)
customparser.add_argument(
'path',
help="Uri on iLO to query HEAD.",
)
customparser.add_argument(
'--silent',
dest='silent',
action="store_true",
help="""Use this flag to silence responses""",
default=None,
)
customparser.add_argument(
'--sessionid',
dest='sessionid',
help="Optionally include this flag if you would prefer to "\
"connect using a session id instead of a normal login.",
default=None
)
customparser.add_argument(
'-f',
'--filename',
dest='filename',
help="""Use the provided filename to perform operations.""",
action="append",
default=None,
)
customparser.add_argument(
'--service',
dest='service',
action="store_true",
help=
"""Use this flag to enable service mode and increase the function speed""",
default=False,
)
def definearguments(self, customparser):
""" Wrapper function for new command main function
:param customparser: command line input
:type customparser: parser.
"""
if not customparser:
return
add_login_arguments_group(customparser)
customparser.add_argument(
'-r',
'--resetqueue',
action='store_true',
dest='resetqueue',
help="""Remove all update tasks in the queue.""",
default=False,
)
customparser.add_argument(
'-c',
'--cleanqueue',
action='store_true',
dest='cleanqueue',
help="""Clean up all finished or errored tasks - leave pending.""",
default=False,
)
customparser.add_argument(
'-j',
'--json',
dest='json',
action="store_true",
help="Optionally include this flag if you wish to change the"\
" displayed output to JSON format. Preserving the JSON data"\
" structure makes the information easier to parse.",
default=False
)
customparser.add_argument(
'--tpmover',
dest='tover',
action="store_true",
help="If set then the TPMOverrideFlag is passed in on the "\
"associated flash operations",
default=False
)
def definearguments(self, customparser):
""" Wrapper function for new command main function
:param customparser: command line input
:type customparser: parser.
"""
if not customparser:
return
add_login_arguments_group(customparser)
customparser.add_argument(
'--results',
dest='results',
help="Optionally include this flag to show results of firmware integrity check.",
default=False,
action='store_true'
)
def definearguments(self, customparser):
""" Wrapper function for new command main function
:param customparser: command line input
:type customparser: parser.
"""
if not customparser:
return
add_login_arguments_group(customparser)
customparser.add_argument(
'--force',
dest='force',
help="Ignore any critical task checking and force disable iLO.",
action="store_true",
default=None,
)
def definearguments(self, customparser):
""" Wrapper function for new command main function
:param customparser: command line input
:type customparser: parser.
"""
if not customparser:
return
add_login_arguments_group(customparser)
customparser.add_argument(
'--controller',
dest='controller',
help="""Use this flag to select the corresponding controller """\
"""using either the slot number or index.""",
default=None,
)
def definearguments(self, customparser):
""" Wrapper function for new command main function
:param customparser: command line input
:type customparser: parser.
"""
if not customparser:
return
add_login_arguments_group(customparser)
customparser.add_argument(
'--confirm',
dest='confirm',
action="store_true",
help="Optionally include to request user confirmation for reboot.",
default=False,
)
def definearguments(self, customparser):
""" Wrapper function for new command main function
:param customparser: command line input
:type customparser: parser.
"""
if not customparser:
return
add_login_arguments_group(customparser)
customparser.add_argument(
'-j',
'--json',
dest='json',
action="store_true",
help="Optionally include this flag if you wish to change the"\
" displayed output to JSON format. Preserving the JSON data"\
" structure makes the information easier to parse.",
default=False
)
customparser.add_argument(
'--description',
dest='description',
help="Optionally include this flag if you would like to add a "\
"description to the maintenance window you create",
default=None
)
customparser.add_argument(
'-n',
'--name',
dest='name',
help="Optionally include this flag if you would like to add a "\
"name to the maintenance window you create. If you do not specify one"\
" a unique name will be added.",
default=None
)
customparser.add_argument(
'--expire',
dest='expire',
help="Optionally include this flag if you would like to add a "\
"time the maintenance window expires.",
default=None
)
def definearguments(self, customparser):
""" Wrapper function for new command main function
:param customparser: command line input
:type customparser: parser.
"""
if not customparser:
return
add_login_arguments_group(customparser)
customparser.add_argument(
'--tpmenabled',
dest='tpmenabled',
action='store_true',
help="Use this flag if the server you are currently logged into"\
" has a TPM chip installed.",
default=False
)
def definearguments(self, customparser):
""" Wrapper function for new command main function
:param customparser: command line input
:type customparser: parser.
"""
if not customparser:
return
add_login_arguments_group(customparser)
customparser.add_argument(
'-a',
'--all',
dest='deleteall',
action="store_true",
help="""Delete all components.""",
default=False,
)
def definearguments(self, customparser):
""" Wrapper function for new command main function
:param customparser: command line input
:type customparser: parser.
"""
if not customparser:
return
add_login_arguments_group(customparser)
customparser.add_argument(
'--biospassword',
dest='biospassword',
help="Select this flag to input a BIOS password. Include this"\
" flag if second-level BIOS authentication is needed for the"\
" command to execute. This option is only used on Gen 9 systems.",
default=None,
)
customparser.add_argument(
'--reboot',
dest='reboot',
help="Use this flag to perform a reboot command function after"\
" completion of operations. For help with parameters and"\
" descriptions regarding the reboot flag, run help reboot.",
default=None,
)
customparser.add_argument(
'--userdefaults',
dest='userdefaults',
action="store_true",
help="Sets bios to user defaults instead of factory "\
"defaults.",
default=False
)
customparser.add_argument(
'--manufacturingdefaults',
dest='manufdefaults',
action="store_true",
help="Reset all configuration settings to manufacturing defaults, "\
"including boot order and secure boot.",
default=False
)
def definearguments(self, customparser):
""" Wrapper function for new command main function
:param customparser: command line input
:type customparser: parser.
"""
if not customparser:
return
add_login_arguments_group(customparser, full=True)
customparser.add_argument(
'--fulltypes',
dest='fulltypes',
action='store_true',
help="Optionally include this flag if you would prefer to "\
"return the full type name instead of the simplified versions" \
" (Redfish only option).",
default=None
)
def definearguments(self, customparser):
""" Wrapper function for certificates command main function
:param customparser: command line input
:type customparser: parser.
"""
if not customparser:
return
add_login_arguments_group(customparser)
customparser.add_argument(
'-f',
'--filename',
dest='filename',
help="Use this flag if you wish to use a different"\
" filename for the certificate signing request. The default" \
" filename is %s." % __filename__,
action="append",
default=None,
)
def definearguments(self, customparser):
""" Wrapper function for new command main function
:param customparser: command line input
:type customparser: parser.
"""
if not customparser:
return
add_login_arguments_group(customparser)
customparser.add_argument(
'-f',
'--filename',
dest='filename',
help="Use this flag if you wish to use a different"\
" filename than the default one. The default filename is" \
" myinstallset.json",
action="append",
default=None
)