Skip to main content
Back to top
Ctrl
+
K
Search
Ctrl
+
K
Restsh
First steps
Install
Configure
Start
Docker
Usage
Examples
General Functions
General Functions
COLUMN
DELETE
DOWNLOAD
GET
HEAD
JQ
JQE
KV
MO
OPTIONS
PATCH
POST
PUT
XARGS
echo_err
echo_ok
echo_verbose
echo_warn
print_json_err
print_json_err_curl
print_json_ok
print_json_ok_curl
print_json_warn
print_json_warn_curl
restsh.check.http-header
restsh.download
restsh.http
restsh.passphrase
restsh.pwgen
restsh.upload
restsh.util.array.includes
restsh.util.array.string
restsh.util.askpass
restsh.util.base64url
restsh.util.check.bool
restsh.util.check.filename
restsh.util.check.isnumber
restsh.util.check.isvarname
restsh.util.check.notempty
restsh.util.check.string
restsh.util.check.uint
restsh.util.check.varnotempty
restsh.util.declare.var
restsh.util.decrypt
restsh.util.encrypt
restsh.util.eval_stage_var
restsh.util.filesize
restsh.util.isencrypted
restsh.util.json_validate
restsh.util.jsonencode
restsh.util.lc
restsh.util.parseoutput
restsh.util.print_formated
restsh.util.print_formated_err
restsh.util.setcurloptions
restsh.util.setvar
restsh.util.setvars
restsh.util.trim
restsh.util.uc
restsh.util.urlencode
restsh.util.var.decrypt
vault.get
vault.login
vault.login.jwt
vault.logout
Modules
Axians Automation Framework
Overview
aafw.art.new
aafw.art.template.list
aafw.cert.new
aafw.group.new
aafw.pipeline.start.as3
aafw.pipeline.start.cert
aafw.pipeline.start.do
aafw.pipeline.start.f5update
aafw.pipeline.start.task.asmsettings
aafw.pipeline.start.task.asmsignaturesets
aafw.pipeline.start.task.asmtemplates
aafw.pipeline.start.task.axscripts
aafw.pipeline.start.task.backup
aafw.pipeline.start.task.cluster
aafw.pipeline.start.task.f5custom
aafw.pipeline.start.task.liveupdate
aafw.pipeline.start.task.pkg
aafw.pipeline.start.task.signaturestaging
aafw.pipeline.start.task.sysdb
aafw.pipeline.start.waf
aafw.project.init.as3
aafw.project.init.cert
aafw.project.init.do
aafw.project.init.f5update
aafw.project.init.tasks
aafw.project.init.waf
aafw.project.new
Certificate
Overview
cert.bundle.show
cert.bundle.split
cert.bundle.verify
cert.csr.create
cert.csr.pubkey
cert.csr.pubkey.hash
cert.csr.show
cert.key.create
cert.key.decrypt
cert.key.encrypt
cert.key.info
cert.key.public
cert.key.public.hash
cert.key.public.verify
cert.key.verify
cert.pkcs12.create
cert.pkcs12.extract
cert.x509.check
cert.x509.create
cert.x509.fingerprint
cert.x509.pubkey
cert.x509.pubkey.hash
cert.x509.show
F5 TMOS
Overview
Examples
f5.apm.client.delete
f5.apm.client.list
f5.apm.epsec.delete
f5.apm.epsec.delete.all
f5.apm.epsec.list
f5.as3.app.declare
f5.as3.app.get
f5.as3.app.list
f5.as3.app.remove
f5.as3.info
f5.as3.taskwait
f5.as3.tenant.declare
f5.as3.tenant.get
f5.as3.tenant.list
f5.as3.tenant.remove
f5.asm.advanced-settings.add
f5.asm.advanced-settings.delete
f5.asm.advanced-settings.getid
f5.asm.advanced-settings.list
f5.asm.advanced-settings.modify
f5.asm.entity.add
f5.asm.entity.filetypes-disallowed.add
f5.asm.entity.filetypes.remove
f5.asm.entity.json-profiles.modify
f5.asm.entity.modify
f5.asm.entity.remove
f5.asm.entity.urls-allowed.add
f5.asm.entity.urls-disallowed.add
f5.asm.entity.urls.remove
f5.asm.entity.whitelist-ips.add
f5.asm.entity.whitelist-ips.remove
f5.asm.event.get
f5.asm.event.list
f5.asm.event.report
f5.asm.learning.accept
f5.asm.learning.delete
f5.asm.learning.ignore
f5.asm.learning.list
f5.asm.learning.overview
f5.asm.live-update.check
f5.asm.live-update.file.cleanup
f5.asm.live-update.file.download
f5.asm.live-update.file.list
f5.asm.live-update.file.remove
f5.asm.live-update.file.upload
f5.asm.live-update.install
f5.asm.live-update.list
f5.asm.live-update.schedule.list
f5.asm.live-update.schedule.set
f5.asm.live-update.stage
f5.asm.live-update.status
f5.asm.openapi.import
f5.asm.policy.apply
f5.asm.policy.assign
f5.asm.policy.audit
f5.asm.policy.check
f5.asm.policy.declare
f5.asm.policy.delete
f5.asm.policy.exists
f5.asm.policy.export
f5.asm.policy.gethash
f5.asm.policy.import
f5.asm.policy.list
f5.asm.policy.new
f5.asm.policy.signature.disable
f5.asm.policy.signature.enforce
f5.asm.policy.signature.get
f5.asm.policy.signature.getid
f5.asm.policy.signature.list
f5.asm.policy.signature.stage
f5.asm.policy.signatureset.attach
f5.asm.policy.signatureset.getid
f5.asm.policy.signatureset.list
f5.asm.policy.signatureset.remove
f5.asm.policy.unused
f5.asm.signatureset.attacktypes
f5.asm.signatureset.create
f5.asm.signatureset.delete
f5.asm.signatureset.filter.create
f5.asm.signatureset.filter.modify
f5.asm.signatureset.get
f5.asm.signatureset.getid
f5.asm.signatureset.list
f5.asm.signatureset.modify
f5.asm.signaturestaging.disable
f5.asm.signaturestaging.enforce
f5.asm.signaturestaging.state
f5.asm.taskwait
f5.asm.template.delete
f5.asm.template.export
f5.asm.template.getid
f5.asm.template.import
f5.asm.template.list
f5.asm.template.update
f5.auth.token.check
f5.auth.token.delete
f5.auth.token.extend
f5.auth.token.get
f5.auth.token.renew
f5.botdefense.override.add
f5.botdefense.override.batch
f5.botdefense.override.list
f5.botdefense.override.remove
f5.botdefense.override.update
f5.botdefense.profile.create
f5.botdefense.profile.delete
f5.botdefense.profile.get
f5.botdefense.profile.list
f5.botdefense.profile.update
f5.botdefense.whitelist.add
f5.botdefense.whitelist.batch
f5.botdefense.whitelist.list
f5.botdefense.whitelist.remove
f5.botdefense.whitelist.update
f5.cert.bundle.import
f5.cert.csr.create
f5.cert.csr.create-from-key
f5.cert.csr.delete
f5.cert.csr.get
f5.cert.csr.list
f5.cert.delete
f5.cert.expire
f5.cert.export
f5.cert.get
f5.cert.import
f5.cert.key.delete
f5.cert.key.export
f5.cert.key.import
f5.cert.key.list
f5.cert.list
f5.cert.pkcs12.import
f5.cli.script.create
f5.cli.script.delete
f5.cli.script.get
f5.cli.script.list
f5.cli.script.run
f5.cli.script.update
f5.cluster.config-sync
f5.cluster.device-groups
f5.cluster.device-groups.sync-failover
f5.cluster.getactive
f5.cluster.getstandby
f5.cluster.setactive
f5.cluster.setstandby
f5.cluster.standby
f5.cluster.sync-status
f5.cluster.traffic-group.ha-group.set
f5.cluster.traffic-group.masquerade.set
f5.common.fullPathJoin
f5.common.fullPathSplit
f5.common.fullPathSplit2
f5.declared.app.declare
f5.declared.app.get
f5.declared.app.list
f5.declared.app.remove
f5.device.cert.check
f5.device.cert.csr.create
f5.device.cert.install
f5.device.cert.reset
f5.device.disable-setup
f5.device.dns.set
f5.device.reboot
f5.do.declare
f5.do.get
f5.do.get.id
f5.do.info
f5.do.reset
f5.do.status
f5.do.taskwait
f5.file-transfer.list
f5.file-transfer.remove
f5.file-transfer.upload
f5.file.download
f5.file.list
f5.file.remove
f5.file.size
f5.file.upload
f5.ltm.clientssl.create
f5.ltm.clientssl.delete
f5.ltm.clientssl.list
f5.ltm.clientssl.replacechain
f5.ltm.datagroup.external.create
f5.ltm.datagroup.external.delete
f5.ltm.datagroup.external.info
f5.ltm.datagroup.external.list
f5.ltm.datagroup.external.update
f5.ltm.datagroup.internal.create
f5.ltm.datagroup.internal.delete
f5.ltm.datagroup.internal.entry.add
f5.ltm.datagroup.internal.entry.remove
f5.ltm.datagroup.internal.get
f5.ltm.datagroup.internal.get_records_from_file
f5.ltm.datagroup.internal.list
f5.ltm.datagroup.internal.update
f5.ltm.ifile.create
f5.ltm.ifile.delete
f5.ltm.ifile.info
f5.ltm.ifile.list
f5.ltm.ifile.update
f5.ltm.irule.batch
f5.ltm.irule.create
f5.ltm.irule.delete
f5.ltm.irule.download
f5.ltm.irule.list
f5.ltm.irule.update
f5.ltm.pool.clone
f5.ltm.pool.create
f5.ltm.pool.delete
f5.ltm.pool.get
f5.ltm.pool.list
f5.ltm.pool.modify
f5.ltm.vs.create
f5.ltm.vs.delete
f5.ltm.vs.get
f5.ltm.vs.lb-detail
f5.ltm.vs.list
f5.ltm.vs.list.state
f5.ltm.vs.modify
f5.net.dns-resolver.add
f5.net.dns-resolver.delete
f5.net.dns-resolver.get
f5.net.dns-resolver.list
f5.net.dns-resolver.modify
f5.net.route-domain.create
f5.net.route-domain.delete
f5.net.route-domain.get
f5.net.route-domain.list
f5.net.selfip.create
f5.net.selfip.delete
f5.net.selfip.list
f5.net.trunk.list
f5.net.vlan.create
f5.net.vlan.delete
f5.net.vlan.list
f5.partition.create
f5.partition.delete
f5.partition.list
f5.password.change.admin
f5.password.change.root
f5.pkg.install
f5.pkg.list
f5.pkg.taskwait
f5.pkg.uninstall
f5.qkview.create
f5.qkview.delete
f5.qkview.download
f5.qkview.list
f5.run
f5.software.hotfix.install
f5.software.hotfix.list
f5.software.image.delete
f5.software.image.download
f5.software.image.install
f5.software.image.list
f5.software.image.upload
f5.software.volume.activate
f5.software.volume.active
f5.software.volume.cpcfg
f5.software.volume.delete
f5.software.volume.list
f5.sslreport.cert-sslprofiles
f5.sslreport.generate
f5.sslreport.sslprofiles-cert
f5.sslreport.sslprofiles-vs
f5.sslreport.vs-sslprofiles
f5.status
f5.sys.datagroup.external.create
f5.sys.datagroup.external.delete
f5.sys.datagroup.external.download
f5.sys.datagroup.external.info
f5.sys.datagroup.external.list
f5.sys.datagroup.external.update
f5.sys.db.get
f5.sys.db.list
f5.sys.db.modify
f5.sys.ha-group.create
f5.sys.ha-group.delete
f5.sys.ha-group.get
f5.sys.ha-group.list
f5.sys.ifile.create
f5.sys.ifile.delete
f5.sys.ifile.download
f5.sys.ifile.info
f5.sys.ifile.list
f5.sys.ifile.update
f5.sys.license
f5.sys.service.get
f5.sys.service.list
f5.sys.service.restart
f5.sys.snmp.disable
f5.sys.snmp.user.create
f5.sys.snmp.user.delete
f5.sys.snmp.user.list
f5.ucs.create
f5.ucs.delete
f5.ucs.download
f5.ucs.list
f5.version
F5OS-A
Overview
f5osa.auth.token.get
f5osa.auth.token.renew
f5osa.backup.create
f5osa.file.delete
f5osa.file.download
f5osa.file.list
f5osa.service.list
f5osa.service.restart
f5osa.tenant.create
f5osa.tenant.delete
f5osa.tenant.get
f5osa.tenant.image.list
f5osa.tenant.list
f5osa.tenant.state
f5osa.version
f5osa.vlan.create
f5osa.vlan.delete
f5osa.vlan.list
GitLab
Overview
Examples
gitlab.api.help
gitlab.branch.create
gitlab.branch.delete
gitlab.branch.exists
gitlab.branch.list
gitlab.branch.protect.delete
gitlab.branch.protect.list
gitlab.branch.protect.set
gitlab.group.access_token.create
gitlab.group.access_token.list
gitlab.group.access_token.revoke
gitlab.group.access_token.rotate
gitlab.group.clone
gitlab.group.create
gitlab.group.delete
gitlab.group.exists
gitlab.group.get
gitlab.group.id
gitlab.group.list
gitlab.group.member.add
gitlab.group.member.list
gitlab.group.member.modify
gitlab.group.member.remove
gitlab.group.move
gitlab.group.path
gitlab.group.projects
gitlab.group.projects.recursive
gitlab.group.purge
gitlab.group.rename
gitlab.group.restore
gitlab.group.subgroups
gitlab.group.variable.batch
gitlab.group.variable.copy
gitlab.group.variable.create
gitlab.group.variable.delete
gitlab.group.variable.delete.all
gitlab.group.variable.export
gitlab.group.variable.import
gitlab.group.variable.list
gitlab.group.variable.update
gitlab.mr.automerge
gitlab.mr.close
gitlab.mr.create
gitlab.mr.list
gitlab.mr.merge
gitlab.project.access_token.create
gitlab.project.access_token.list
gitlab.project.access_token.revoke
gitlab.project.access_token.rotate
gitlab.project.archive
gitlab.project.clone
gitlab.project.create
gitlab.project.delete
gitlab.project.exists
gitlab.project.export
gitlab.project.fork
gitlab.project.get
gitlab.project.history
gitlab.project.id
gitlab.project.job.artifact
gitlab.project.job.cancel
gitlab.project.job.erase
gitlab.project.job.log
gitlab.project.job.retry
gitlab.project.job.start
gitlab.project.job_token_scope.allowlist.add
gitlab.project.job_token_scope.allowlist.list
gitlab.project.job_token_scope.allowlist.remove
gitlab.project.job_token_scope.push
gitlab.project.list
gitlab.project.member.add
gitlab.project.member.list
gitlab.project.member.modify
gitlab.project.member.remove
gitlab.project.move
gitlab.project.path
gitlab.project.pipeline.jobs
gitlab.project.pipeline.latest
gitlab.project.pipeline.latest.jobs
gitlab.project.pipeline.latest.wait
gitlab.project.pipeline.list
gitlab.project.pipeline.path
gitlab.project.pipeline.start
gitlab.project.pipeline.variables
gitlab.project.purge
gitlab.project.rename
gitlab.project.restore
gitlab.project.schedules.create
gitlab.project.schedules.delete
gitlab.project.schedules.get
gitlab.project.schedules.list
gitlab.project.schedules.start
gitlab.project.schedules.state
gitlab.project.variable.batch
gitlab.project.variable.copy
gitlab.project.variable.create
gitlab.project.variable.delete
gitlab.project.variable.delete.all
gitlab.project.variable.export
gitlab.project.variable.import
gitlab.project.variable.list
gitlab.project.variable.update
gitlab.repository.export
gitlab.repository.file.add
gitlab.runner.create
gitlab.runner.delete
gitlab.runner.jobs
gitlab.runner.list
gitlab.util.list
gitlab.version
MyF5 API
Overview
Examples
myf5.auth.login
myf5.auth.token.renew
myf5.downloads.get.as3
myf5.downloads.get.do
myf5.downloads.metadata
myf5.downloads.product
myf5.downloads.product.containers
myf5.downloads.product.families
myf5.downloads.product.files
myf5.downloads.product.lines
myf5.downloads.product.links
Sectigo Cert Manager
Overview
scm.auth.login
scm.csr.sign
Advanced
Atuin
Developing Restsh functions
Passwords and Secrets
Scripting
Mustache Templating
Functions
Tutorials
F5 AS3 Management
F5 Certificate Deployment with HashiCorp Vault
F5 Declarative Onboarding (DO)
F5 Declarative WAF
F5 File Management
F5 New Declarative API
GitLab Pipeline
Changelog
GNU GENERAL PUBLIC LICENSE
.md
.pdf
vault.get
vault.get
#
Get value from Vault.
Usage:
vault
.
get
<
VAULT_PATH
>
<
VAULT_KEY
>
