Overview for f5

Overview for f5#

Function

Description

f5.apm.client.delete

Deletes an APM Client Image.

f5.apm.client.list

Lists APM Client Images.

f5.apm.epsec.delete

Deletes a EPSEC Package.

f5.apm.epsec.delete.all

Deletes all EPSEC packages that are not installed and not a system package.

f5.apm.epsec.list

Lists EPSEC Packages.

f5.as3.app.declare

Posts an AS3 declaration to declare a single app in a tenant, optionally runs mustache before.

f5.as3.app.get

Gets an AS3 Application from a Tenant.

f5.as3.app.list

Lists all applications in an AS3 tenant.

f5.as3.app.remove

Removes an AS3 Application from a Tenant. Deletes the Tenant also if it was the last Application.

f5.as3.info

Returns the installed AS3 version.

f5.as3.taskwait

Waits for an AS3 task to be finished

f5.as3.tenant.declare

Posts an AS3 declaration to declare a complete tenant, optionally runs mustache before.

f5.as3.tenant.get

Gets an AS3 Tenant Declaration.

f5.as3.tenant.list

Lists all AS3 Tenants.

f5.as3.tenant.remove

Removes an AS3 Tenant by posting an empty declaration.

f5.asm.advanced-settings.add

Creates a new F5 ASM Advanced Setting (System Variable).

f5.asm.advanced-settings.delete

Deletes a F5 ASM Advanced Setting (System Variable).

f5.asm.advanced-settings.getid

Get’s the ID for a F5 ASM Advanced Setting by name.

f5.asm.advanced-settings.list

Lists all F5 ASM Advanced Settings (System Variables).

f5.asm.advanced-settings.modify

Modifies a F5 ASM Advanced Setting (System Variable).

f5.asm.entity.add

Adds an entity to a F5 ASM Policy.

f5.asm.entity.filetypes-disallowed.add

Adds a disallowed filetype to a F5 ASM Policy.

f5.asm.entity.filetypes.remove

Removes a filetype from a F5 ASM Policy.

f5.asm.entity.json-profiles.modify

Sets the defense attributes of all json content profiles for specified ASM policy.

f5.asm.entity.modify

Modifies an entity for a F5 ASM Policy.

f5.asm.entity.remove

Removes an entity from a F5 ASM Policy.

f5.asm.entity.urls-allowed.add

Adds an allowed url to a F5 ASM Policy.

f5.asm.entity.urls-disallowed.add

Adds a disallowed url to a F5 ASM Policy.

f5.asm.entity.urls.remove

Removes a url from a F5 ASM Policy.

f5.asm.entity.whitelist-ips.add

Adds ips to the whitelist of a F5 ASM Policy.

f5.asm.entity.whitelist-ips.remove

Remove the ip from the whitelist of a F5 ASM Policy.

f5.asm.event.get

Gets an ASM Event.

f5.asm.event.list

Lists ASM Events.

f5.asm.event.report

Export ASM Event Report in html.

f5.asm.learning.accept

Ignores a suggestions by id.

f5.asm.learning.delete

Deletes a suggestions by id.

f5.asm.learning.ignore

Ignores a suggestions by id.

f5.asm.learning.list

Lists all suggestions.

f5.asm.learning.overview

Prints a suggestions overview.

f5.asm.live-update.check

Check and retrieve the live update component file.

f5.asm.live-update.file.download

Downloads a live-update file.

f5.asm.live-update.file.list

Gets the list of live-update files.

f5.asm.live-update.file.remove

Removes a live-update file.

f5.asm.live-update.file.upload

Uploads and registers a live-update file.

f5.asm.live-update.install

Installs a live-update file.

f5.asm.live-update.list

Lists the available live-update files.

f5.asm.live-update.schedule.list

Lists live-update schedules for all components.

f5.asm.live-update.schedule.set

Lists live-update schedules for all components.

f5.asm.live-update.status

Gets the live update status.

f5.asm.openapi.import

Imports an OpenAPI file into a F5 ASM policy.

f5.asm.policy.apply

Applies a F5 ASM Policy by it’s fullPath or hash.

f5.asm.policy.assign

Assigns a F5 ASM Policy to virtual servers.

f5.asm.policy.audit

Displays the audit log for a F5 ASM Policy.

f5.asm.policy.check

Checks a F5 ASM Policy against best practices.

f5.asm.policy.declare

Imports a declarative waf policy.

f5.asm.policy.delete

Deletes a F5 ASM Policy.

f5.asm.policy.exists

Checks if policy with specified name exists.

f5.asm.policy.export

Exports a F5 ASM Policy.

f5.asm.policy.gethash

Calculates the hash of a F5 ASM Policy fullPath.

f5.asm.policy.import

Imports a F5 ASM Policy in json, binary or xml format.

f5.asm.policy.list

Lists all F5 ASM Policies.

f5.asm.policy.new

Creates a new F5 ASM Policy.

f5.asm.policy.signature.disable

Disables a specific attack signature in a policy.

f5.asm.policy.signature.enforce

Enforces a specific attack signature in a policy.

f5.asm.policy.signature.get

Gets the state of a specific attack signature in a policy.

f5.asm.policy.signature.getid

Gets the id of signature for a policy by global signatureId

f5.asm.policy.signature.list

Lists all attack signature in a policy.

f5.asm.policy.signature.stage

Stages a specific attack signature in a policy.

f5.asm.policy.signatureset.attach

Attaches a specific attack signature set to a policy.

f5.asm.policy.signatureset.getid

Gets the id of signature set for a policy by name.

f5.asm.policy.signatureset.list

Lists all attack signature sets attached to a WAF policy.

f5.asm.policy.signatureset.remove

Attaches a specific attack signature set to a policy.

f5.asm.policy.unused

Lists all unused F5 ASM Policies.

f5.asm.signatureset.attacktypes

Lists all custom signature sets.

f5.asm.signatureset.create

Creates a new manual signature set.

f5.asm.signatureset.delete

Deletes a signature set and removes it from any referencing policy.

f5.asm.signatureset.filter.create

Creates a new filter based signature set.

f5.asm.signatureset.filter.modify

Creates a new filter based signature set.

f5.asm.signatureset.get

Gets a signature set.

f5.asm.signatureset.getid

Gets the signature set id by name.

f5.asm.signatureset.list

Lists all custom signature sets.

f5.asm.signatureset.modify

Modifies a manual signature set.

f5.asm.signaturestaging.disable

Disables signatures with learning suggestions.

f5.asm.signaturestaging.enforce

Enforces all ready to be enforced signatures.

f5.asm.signaturestaging.state

Lists ASM signature staging status.

f5.asm.taskwait

Waits for a ASM task to be finished.

f5.asm.template.delete

Deletes a F5 ASM Policy Template.

f5.asm.template.export

Exports a F5 ASM Policy Template.

f5.asm.template.getid

Gets the id of an ASM policy template

f5.asm.template.import

Imports a F5 ASM Policy Template.

f5.asm.template.list

Lists all F5 ASM Policy Templates.

f5.asm.template.update

Imports a F5 ASM Policy Template.

f5.auth.token.check

Checks the authentication token from a f5.

f5.auth.token.delete

Deletes the authentication token from a f5 and clears the RESTSH_TOKEN_VALUE environment variable.

f5.auth.token.extend

Sets a new timeout for the authentication token.

f5.auth.token.get

Gets the authentication token from a f5 and sets the RESTSH_TOKEN_VALUE environment variable.

f5.auth.token.renew

Renews the token if it will expire in the next 5 minutes

f5.botdefense.override.add

Adds an entry to the F5 Bot Defense Profile Overrides.

f5.botdefense.override.batch

Replaces Override Entries for a F5 Bot Defense Profile with the content of a CSV.

f5.botdefense.override.list

Lists all Overrides for a F5 Bot Defense Profile.

f5.botdefense.override.remove

Removes an entry from the F5 Bot Defense Profile Overrides.

f5.botdefense.override.update

Updates an entry in the F5 Bot Defense Profile Overrides.

f5.botdefense.profile.create

Creates a F5 Bot Defense Profile.

f5.botdefense.profile.delete

Deletes a F5 Bot Defense Profile.

f5.botdefense.profile.get

Gets a F5 Bot Defense Profile.

f5.botdefense.profile.list

Lists all F5 Bot Defense Profiles.

f5.botdefense.profile.update

Updates a F5 Bot Defense Profile.

f5.botdefense.whitelist.add

Adds an entry to the F5 Bot Defense Profile Whitelist.

f5.botdefense.whitelist.batch

Replaces Whitelist Entries for a F5 Bot Defense Profile with the content of a CSV.

f5.botdefense.whitelist.list

Lists all Whitelist Entries for a F5 Bot Defense Profile.

f5.botdefense.whitelist.remove

Removes an entry from the F5 Bot Defense Profile Whitelist.

f5.botdefense.whitelist.update

Updates an entry in the F5 Bot Defense Profile Whitelist.

f5.cert.bundle.import

Imports traffic management key + cert + optional chain file.

f5.cert.csr.create

Creates a key and a certificate signing request.

f5.cert.csr.create-from-key

Creates a certificate signing request from existing key.

f5.cert.csr.delete

Deletes a csr on the F5.

f5.cert.csr.get

Gets a CSR and prints it to STDOUT.

f5.cert.csr.list

Lists CSRs on the F5.

f5.cert.delete

Deletes traffic management certificates on the F5.

f5.cert.expire

Lists all traffic management certificates that should be renewed.

f5.cert.export

Exports a traffic management certificate.

f5.cert.get

Shows details of a traffic management certificate.

f5.cert.import

Imports traffic management certificates on the F5.

f5.cert.key.delete

Deletes traffic management certificate keys on the F5.

f5.cert.key.export

Exports a traffic management private key.

f5.cert.key.import

Imports a traffic management certificate key into the F5.

f5.cert.key.list

Lists traffic management certificate keys on the F5.

f5.cert.list

Lists traffic management certificates on the F5.

f5.cert.pkcs12.import

Imports and optionally uploads a pkcs12 file.

f5.cluster.config-sync

Synchronizes the config to the device group.

f5.cluster.device-groups

Lists device groups.

f5.cluster.device-groups.sync-failover

Returns the name of the sync-failover device group.

f5.cluster.getactive

Returns the active device from a f5 cluster.

f5.cluster.getstandby

Returns the standby device from a f5 cluster.

f5.cluster.setactive

Sets the RESTSH_HOST environment variable to the active member of the F5 cluster.

f5.cluster.setstandby

Sets the RESTSH_HOST environment variable to the standby member of the F5 cluster.

f5.cluster.standby

Sets the F5 as standby in the cluster.

f5.cluster.sync-status

Gets the synchronization status.

f5.cluster.traffic-group.ha-group.set

Sets the ha-group for a traffic-group.

f5.common.fullPathJoin

Joins path components with defined separator.

f5.common.fullPathSplit

Splits the fullPath into partition and name

f5.common.fullPathSplit2

Splits the fullPath into partition, subpath and name

f5.device.cert.check

Checks for a valid device certificate.

f5.device.cert.csr.create

Installs a device certificate.

f5.device.cert.install

Uploads and installs a device certificate, restarts httpd.

f5.device.cert.reset

Resets the device certificate and key to server.crt and server.key.

f5.device.disable-setup

Disables the initial setup wizard.

f5.device.dns.set

Sets DNS Servers.

f5.device.reboot

Reboots the F5.

f5.do.declare

Posts a Declarative Onboarding declaration, optionally runs mustache before.

f5.do.get

Retrieves the Declarative Onboarding configuration.

f5.do.get.id

Retrieves the Declarative Onboarding configuration ID.

f5.do.info

Returns the installed Declarative Onboarding version.

f5.do.reset

Resets the Declarative Onboarding configuration.

f5.do.status

Gets the Declarative Onboarding status.

f5.do.taskwait

Waits for an Declarative Onboarding task to be finished

f5.file-transfer.list

Lists a file in /var/config/rest/downloads

f5.file-transfer.remove

Removes a file from /var/config/rest/downloads

f5.file-transfer.upload

Uploads a file to /var/config/rest/downloads

f5.file.download

Downloads a file from the F5.

f5.file.list

Lists a file or directory on the F5.

f5.file.remove

Deletes a file from the F5.

f5.file.size

Get the size of a file on the F5.

f5.file.upload

Uploads a file to the F5.

f5.image.delete

Deletes a F5 software image, directory: /shared/images/.

f5.image.download

Downloads a F5 software image, directory: /shared/images/.

f5.image.list

Lists F5 software images (or other files), directory: /shared/images/.

f5.image.upload

Uploads a F5 software image, directory: /shared/images/.

f5.ltm.clientssl.create

Creates a new ClientSSL profile on the F5.

f5.ltm.clientssl.delete

Deletes a ClientSSL profile on the F5.

f5.ltm.clientssl.list

Lists ClientSSL profiles on the F5.

f5.ltm.clientssl.replacechain

Replaces the certificate,key and chain of a ClientSSL profiles on the F5.

f5.ltm.datagroup.external.create

Creates an external datagroup.

f5.ltm.datagroup.external.delete

Deletes an external datagroup.

f5.ltm.datagroup.external.info

Shows details of an external datagroup.

f5.ltm.datagroup.external.list

Lists external datagroups.

f5.ltm.datagroup.external.update

Updates the external filename for an external datagroup.

f5.ltm.datagroup.internal.create

Creates an internal datagroup.

f5.ltm.datagroup.internal.delete

Deletes an internal datagroup.

f5.ltm.datagroup.internal.entry.add

Manages internal datagroups.

f5.ltm.datagroup.internal.entry.remove

Removes an entry from an internal datagroup.

f5.ltm.datagroup.internal.get

Gets an internal datagroup.

f5.ltm.datagroup.internal.get_records_from_file

Returns the formatted internal datagroup records from a file

f5.ltm.datagroup.internal.list

Lists internal datagroups.

f5.ltm.datagroup.internal.update

Updates an internal datagroup.

f5.ltm.ifile.create

Creates a LTM iFile.

f5.ltm.ifile.delete

Deletes a LTM iFile.

f5.ltm.ifile.info

Shows detail of a LTM iFile.

f5.ltm.ifile.list

Lists LTM iFiles.

f5.ltm.ifile.update

Changes the sys iFile reference for the LTM iFile.

f5.ltm.irule.batch

Batch management of iRules.

f5.ltm.irule.create

Creates an iRule.

f5.ltm.irule.delete

Deletes an iRule.

f5.ltm.irule.download

Downloads an iRule.

f5.ltm.irule.list

Lists iRules.

f5.ltm.irule.update

Updates a iRule.

f5.ltm.pool.list

Lists Pools.

f5.ltm.vs.create

Creates a Virtual Server.

f5.ltm.vs.delete

Deletes a Virtual Server.

f5.ltm.vs.get

Gets a Virtual Servers.

f5.ltm.vs.lb-detail

Lists a pool and its members that is linked to a virtual server.

f5.ltm.vs.list

Lists Virtual Servers.

f5.ltm.vs.modify

Modifies a Virtual Server.

f5.net.dns-resolver.add

Adds a dns-resolver.

f5.net.dns-resolver.delete

Deletes a dns-resolver.

f5.net.dns-resolver.get

Gets a dns-resolver.

f5.net.dns-resolver.list

Lists dns-resolvers.

f5.net.dns-resolver.modify

Modifies a dns-resolver.

f5.net.selfip.create

Creates a Self IP.

f5.net.selfip.delete

Deletes a Self IP.

f5.net.selfip.list

Lists Self IPs.

f5.net.trunk.list

Lists Trunks.

f5.net.vlan.create

Creates a VLAN.

f5.net.vlan.delete

Deletes a VLAN.

f5.net.vlan.list

Lists VLANs.

f5.password.change.admin

Changes the admin account password.

f5.password.change.root

Changes the root account password.

f5.pkg.install

Installs an iAPPs LX Package.

f5.pkg.list

Lists all installed iAPPs LX Packages.

f5.pkg.taskwait

Waits for a package management task to be finished.

f5.pkg.uninstall

Uninstalls an iAPPs LX Package.

f5.qkview.create

Creates a QKView and waits for the task to finish.

f5.qkview.delete

Deletes QKViews on the F5.

f5.qkview.download

Downloads a QKView from the F5.

f5.qkview.list

Manages QKViews on the F5.

f5.run

Runs a shell command on the F5.

f5.sslreport.cert-sslprofiles

Gets ssl profiles for certificates.

f5.sslreport.generate

Creates a certificate and ssl profiles usage report in html or markdown format.

f5.sslreport.sslprofiles-cert

Gets certificates for ClientSSL profiles.

f5.sslreport.sslprofiles-vs

Lists all ssl profiles with its associated virtual servers.

f5.sslreport.vs-sslprofiles

Lists all Virtual Servers with its associated ssl profiles.

f5.status

Gets the F5 status.

f5.sys.datagroup.external.create

Creates an external system datagroup.

f5.sys.datagroup.external.delete

Deletes an external system datagroup.

f5.sys.datagroup.external.download

Downloads an external system datagroup.

f5.sys.datagroup.external.info

Shows details of an external system datagroup.

f5.sys.datagroup.external.list

Lists external system datagroups.

f5.sys.datagroup.external.update

Updates an external system datagroup.

f5.sys.db.get

Gets a System Variables.

f5.sys.db.list

Lists System Variables.

f5.sys.db.modify

Modifies a System Variable.

f5.sys.ha-group.create

Creates a ha-group.

f5.sys.ha-group.delete

Deletes a ha-group.

f5.sys.ha-group.get

Gets a ha-group.

f5.sys.ha-group.list

Lists ha-groups.

f5.sys.ifile.create

Creates a System iFile.

f5.sys.ifile.delete

Deletes a System iFile.

f5.sys.ifile.download

Downloads a System iFile.

f5.sys.ifile.info

Shows detail of a System iFile.

f5.sys.ifile.list

Lists System iFiles.

f5.sys.ifile.update

Updates a System iFile.

f5.sys.license

Shows some basic license and service information.

f5.sys.service.get

Gets the state of a service.

f5.sys.service.list

Lists System Services.

f5.sys.service.restart

Restarts a service.

f5.sys.snmp.disable

Disables snmp v1 and v2c.

f5.sys.snmp.user.create

Creates a snmp v3 user.

f5.sys.snmp.user.delete

Deletes a snmp v3 user.

f5.sys.snmp.user.list

Lists snmp v3 users.

f5.ucs.create

Creates an ucs file on the F5, /var/local/ucs/.

f5.ucs.delete

Deletes an ucs file on the F5, /var/local/ucs/.

f5.ucs.download

Manages ucs on the F5, /var/local/ucs/.

f5.ucs.list

Lists ucs files on the F5, directory: /var/local/ucs/.

f5.version

Gets the F5 version.