openapi: 3.0.0
info:
  title: f5-utils-file-transfer
  description: Provide support to do file transfer operations on the System.
  contact:
    name: F5 Networks
    url: https://www.f5.com/F5OS/
    email: f5os@f5.com
  version: '2020-12-10'
servers:
- url: http://{defaultHost}
  variables:
    defaultHost:
      default: www.example.com/restconf
- url: https://{defaultHost}
  variables:
    defaultHost:
      default: www.example.com/restconf
paths:
  /data/f5-utils-file-transfer:file:
    get:
      tags:
      - F5 Utils File Transfer
      summary: data_f5_utils_file_transfer_file_get
      description: File utility commands.
      operationId: data_f5_utils_file_transfer_file_get
      parameters: []
      responses:
        '200':
          description: File utility commands.
          headers: {}
          content:
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/data_f5-utils-file-transfer_file'
      deprecated: false
      security:
      - basicAuth: []
    post:
      tags:
      - F5 Utils File Transfer
      summary: data_f5_utils_file_transfer_file_post
      description: File utility commands.
      operationId: data_f5_utils_file_transfer_file_post
      parameters: []
      requestBody:
        description: File utility commands.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/data_f5-utils-file-transfer_file-post'
              - description: File utility commands.
        required: true
      responses:
        '201':
          description: container file created
          headers: {}
          content: {}
      deprecated: false
      security:
      - basicAuth: []
    put:
      tags:
      - F5 Utils File Transfer
      summary: data_f5_utils_file_transfer_file_put
      description: File utility commands.
      operationId: data_f5_utils_file_transfer_file_put
      parameters: []
      requestBody:
        description: File utility commands.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/data_f5-utils-file-transfer_file'
              - description: File utility commands.
        required: true
      responses:
        '201':
          description: container file created or replaced
          headers: {}
          content: {}
      deprecated: false
      security:
      - basicAuth: []
    patch:
      tags:
      - F5 Utils File Transfer
      summary: data_f5_utils_file_transfer_file_patch
      description: File utility commands.
      operationId: data_f5_utils_file_transfer_file_patch
      parameters: []
      requestBody:
        description: File utility commands.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/data_f5-utils-file-transfer_file'
              - description: File utility commands.
        required: true
      responses:
        '204':
          description: container file updated
          headers: {}
          content: {}
      deprecated: false
      security:
      - basicAuth: []
    delete:
      tags:
      - F5 Utils File Transfer
      summary: data_f5_utils_file_transfer_file_delete
      description: File utility commands.
      operationId: data_f5_utils_file_transfer_file_delete
      parameters: []
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
      deprecated: false
      security:
      - basicAuth: []
  /data/f5-utils-file-transfer:file/import:
    post:
      tags:
      - F5 Utils File Transfer
      summary: data_f5_utils_file_transfer_file_import_post
      description: Initiate an import of the remote file to the System.
      operationId: data_f5_utils_file_transfer_file_import_post
      parameters: []
      requestBody:
        description: Initiate an import of the remote file to the System.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/data_f5-utils-file-transfer_file_import-post-input'
              - description: Initiate an import of the remote file to the System.
        required: true
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/data_f5-utils-file-transfer_file_import-post-output'
      deprecated: false
      security:
      - basicAuth: []
  /data/f5-utils-file-transfer:file/export:
    post:
      tags:
      - F5 Utils File Transfer
      summary: data_f5_utils_file_transfer_file_export_post
      description: Initiate an export of the file to the remote system.
      operationId: data_f5_utils_file_transfer_file_export_post
      parameters: []
      requestBody:
        description: Initiate an export of the file to the remote system.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/data_f5-utils-file-transfer_file_import-post-input'
              - description: Initiate an export of the file to the remote system.
        required: true
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/data_f5-utils-file-transfer_file_export-post-output'
      deprecated: false
      security:
      - basicAuth: []
  /data/f5-utils-file-transfer:file/delete:
    post:
      tags:
      - F5 Utils File Transfer
      summary: data_f5_utils_file_transfer_file_delete_post
      description: Delete an existing file. The result will indicate a success or failure.
      operationId: data_f5_utils_file_transfer_file_delete_post
      parameters: []
      requestBody:
        description: Delete an existing file. The result will indicate a success or failure.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/data_f5-utils-file-transfer_file_delete-post-input'
              - description: Delete an existing file. The result will indicate a success or failure.
        required: true
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/data_f5-utils-file-transfer_file_delete-post-output'
      deprecated: false
      security:
      - basicAuth: []
  /data/f5-utils-file-transfer:file/list:
    post:
      tags:
      - F5 Utils File Transfer
      summary: data_f5_utils_file_transfer_file_list_post
      description: Display list of directories/files in the given path.
      operationId: data_f5_utils_file_transfer_file_list_post
      parameters: []
      requestBody:
        description: Display list of directories/files in the given path.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/data_f5-utils-file-transfer_file_list-post-input'
              - description: Display list of directories/files in the given path.
        required: true
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/data_f5-utils-file-transfer_file_list-post-output'
      deprecated: false
      security:
      - basicAuth: []
  /data/f5-utils-file-transfer:file/transfer-status:
    post:
      tags:
      - F5 Utils File Transfer
      summary: data_f5_utils_file_transfer_file_transfer_status_post
      description: >-
        Display the status of file operation.

        The result will indicate an error, or percent complete.
      operationId: data_f5_utils_file_transfer_file_transfer_status_post
      parameters: []
      requestBody:
        description: >-
          Display the status of file operation.

          The result will indicate an error, or percent complete.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/data_f5-utils-file-transfer_file_transfer-status-post-input'
              - description: >-
                  Display the status of file operation.

                  The result will indicate an error, or percent complete.
        required: true
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/data_f5-utils-file-transfer_file_transfer-status-post-output'
      deprecated: false
      security:
      - basicAuth: []
  /data/openconfig-system:system/f5-database:database:
    get:
      tags:
      - F5 Openconfig System
      summary: data_openconfig_system_system_f5_database_database_get
      description: ''
      operationId: data_openconfig_system_system_f5_database_database_get
      parameters: []
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/data_openconfig-system_system_f5-database_database'
      deprecated: false
      security:
      - basicAuth: []
    post:
      tags:
      - F5 Openconfig System
      summary: data_openconfig_system_system_f5_database_database_post
      description: ''
      operationId: data_openconfig_system_system_f5_database_database_post
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/data_openconfig-system_system_f5-database_database-post'
        required: true
      responses:
        '201':
          description: container database created
          headers: {}
          content: {}
      deprecated: false
      security:
      - basicAuth: []
    put:
      tags:
      - F5 Openconfig System
      summary: data_openconfig_system_system_f5_database_database_put
      description: ''
      operationId: data_openconfig_system_system_f5_database_database_put
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/data_openconfig-system_system_f5-database_database'
        required: true
      responses:
        '201':
          description: container database created or replaced
          headers: {}
          content: {}
      deprecated: false
      security:
      - basicAuth: []
    patch:
      tags:
      - F5 Openconfig System
      summary: data_openconfig_system_system_f5_database_database_patch
      description: ''
      operationId: data_openconfig_system_system_f5_database_database_patch
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/data_openconfig-system_system_f5-database_database'
        required: true
      responses:
        '204':
          description: container database updated
          headers: {}
          content: {}
      deprecated: false
      security:
      - basicAuth: []
    delete:
      tags:
      - F5 Openconfig System
      summary: data_openconfig_system_system_f5_database_database_delete
      description: ''
      operationId: data_openconfig_system_system_f5_database_database_delete
      parameters: []
      responses:
        '204':
          description: No Content
          headers: {}
          content: {}
      deprecated: false
      security:
      - basicAuth: []
  /data/openconfig-system:system/f5-database:database/f5-database:config-backup:
    post:
      tags:
      - F5 Openconfig System
      summary: data_openconfig_system_system_f5_database_database_f5_database_config_backup_post
      description: ''
      operationId: data_openconfig_system_system_f5_database_database_f5_database_config_backup_post
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/data_openconfig-system_system_f5-database_database_f5-database_config-backup-post-input'
        required: true
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/data_openconfig-system_system_f5-database_database_f5-database_config-backup-post-output'
      deprecated: false
      security:
      - basicAuth: []
  /data/openconfig-system:system/f5-database:database/f5-database:cdb-backup:
    post:
      tags:
      - F5 Openconfig System
      summary: data_openconfig_system_system_f5_database_database_f5_database_cdb_backup_post
      description: ''
      operationId: data_openconfig_system_system_f5_database_database_f5_database_cdb_backup_post
      parameters: []
      requestBody:
        description: ''
        content:
          text/plain:
            schema:
              type: object
        required: true
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/data_openconfig-system_system_f5-database_database_f5-database_cdb-backup-post-output'
      deprecated: false
      security:
      - basicAuth: []
  /data/openconfig-system:system/f5-database:database/f5-database:config-restore:
    post:
      tags:
      - F5 Openconfig System
      summary: data_openconfig_system_system_f5_database_database_f5_database_config_restore_post
      description: ''
      operationId: data_openconfig_system_system_f5_database_database_f5_database_config_restore_post
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/data_openconfig-system_system_f5-database_database_f5-database_config-restore-post-input'
        required: true
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/data_openconfig-system_system_f5-database_database_f5-database_config-restore-post-output'
      deprecated: false
      security:
      - basicAuth: []
  /data/openconfig-system:system/f5-database:database/f5-database:reset-to-default:
    post:
      tags:
      - F5 Openconfig System
      summary: data_openconfig_system_system_f5_database_database_f5_database_reset_to_default_post
      description: ''
      operationId: data_openconfig_system_system_f5_database_database_f5_database_reset_to_default_post
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/data_openconfig-system_system_f5-database_database_f5-database_reset-to-default-post-input'
        required: true
      responses:
        '201':
          description: Created
          headers: {}
          content:
            application/yang-data+json:
              schema:
                $ref: '#/components/schemas/data_openconfig-system_system_f5-database_database_f5-database_reset-to-default-post-output'
      deprecated: false
      security:
      - basicAuth: []
components:
  schemas:
    data_f5-utils-file-transfer_file_transfer-status-post-output:
      title: data_f5-utils-file-transfer_file_transfer-status-post-output
      type: object
      properties:
        f5-utils-file-transfer:result:
          type: string
          description: A message indicating the result of the file transfer status. (leaf)
        f5-utils-file-transfer:resultint:
          type: string
          description: An error indicator. A Zero value (0) indicates success. (leaf)
    data_f5-utils-file-transfer_file_transfer-status-post-input:
      title: data_f5-utils-file-transfer_file_transfer-status-post-input
      type: object
      properties:
        f5-utils-file-transfer:file-name:
          type: string
          description: Local file path. Accepts either absolute or relative path. (leaf)
    data_f5-utils-file-transfer_file_list-post-output:
      title: data_f5-utils-file-transfer_file_list-post-output
      type: object
      properties:
        f5-utils-file-transfer:entries:
          type: array
          items:
            $ref: '#/components/schemas/F5UtilsFileTransferEntry'
          description: (list)
    data_f5-utils-file-transfer_file_list-post-input:
      title: data_f5-utils-file-transfer_file_list-post-input
      type: object
      properties:
        f5-utils-file-transfer:path:
          type: string
          description: Provide the directory/file path. (leaf)
    data_f5-utils-file-transfer_file_import-post-output:
      title: data_f5-utils-file-transfer_file_import-post-output
      type: object
      properties:
        f5-utils-file-transfer:result:
          type: string
          description: A message indicating the result of import file transfer action. (leaf)
        f5-utils-file-transfer:resultint:
          type: string
          description: An error indicator. A Zero value (0) indicates success. (leaf)
    data_f5-utils-file-transfer_file_import-post-input:
      title: data_f5-utils-file-transfer_file_import-post-input
      type: object
      properties:
        f5-utils-file-transfer:insecure:
          type: string
          description: Disable remote system identity verification (leaf)
        f5-utils-file-transfer:protocol:
          $ref: '#/components/schemas/F5UtilsFileTransferProtocol'
        f5-utils-file-transfer:username:
          type: string
          description: Provide the remote system username. (leaf)
        f5-utils-file-transfer:password:
          type: string
          description: Provide the remote system password in simple text. (leaf)
        f5-utils-file-transfer:web-token:
          type: string
          description: Provide the remote system web token. (leaf)
        f5-utils-file-transfer:remote-host:
          type: string
          description: Remote System FQDN or IPv4/IPv6 address. (leaf)
        f5-utils-file-transfer:remote-port:
          type: integer
          description: Provide port to connect to on the remote host. (leaf)
          format: int32
        f5-utils-file-transfer:remote-file:
          type: string
          description: Remote file path. (leaf)
        f5-utils-file-transfer:local-file:
          type: string
          description: Local file path. Accepts either absolute or relative path. (leaf)
    data_f5-utils-file-transfer_file_export-post-output:
      title: data_f5-utils-file-transfer_file_export-post-output
      type: object
      properties:
        f5-utils-file-transfer:result:
          type: string
          description: A message indicating the result of export file transfer action. (leaf)
        f5-utils-file-transfer:resultint:
          type: string
          description: An error indicator. A Zero value (0) indicates success. (leaf)
    data_f5-utils-file-transfer_file_export-post-input:
      title: data_f5-utils-file-transfer_file_export-post-input
      type: object
      properties:
        f5-utils-file-transfer:insecure:
          type: string
          description: Disable remote system identity verification (leaf)
        f5-utils-file-transfer:protocol:
          $ref: '#/components/schemas/F5UtilsFileTransferProtocol'
        f5-utils-file-transfer:username:
          type: string
          description: Provide the remote system username. (leaf)
        f5-utils-file-transfer:password:
          type: string
          description: Provide the remote system password in simple text. (leaf)
        f5-utils-file-transfer:web-token:
          type: string
          description: Provide the remote system web token. (leaf)
        f5-utils-file-transfer:local-file:
          type: string
          description: Local file path. Accepts either absolute or relative path. (leaf)
        f5-utils-file-transfer:remote-host:
          type: string
          description: Remote System FQDN or IPv4/IPv6 address. (leaf)
        f5-utils-file-transfer:remote-port:
          type: integer
          description: Provide port to connect to on the remote host. (leaf)
          format: int32
        f5-utils-file-transfer:remote-file:
          type: string
          description: Remote file path. (leaf)
    data_f5-utils-file-transfer_file_delete-post-output:
      title: data_f5-utils-file-transfer_file_delete-post-output
      type: object
      properties:
        f5-utils-file-transfer:result:
          type: string
          description: A message indicating the result of the delete file action. (leaf)
        f5-utils-file-transfer:resultint:
          type: string
          description: An error indicator. A Zero value (0) indicates success. (leaf)
    data_f5-utils-file-transfer_file_delete-post-input:
      title: data_f5-utils-file-transfer_file_delete-post-input
      type: object
      properties:
        f5-utils-file-transfer:file-name:
          type: string
          description: >-
            Provide the file name to be deleted. Accepts either

            absolute or relative path. (leaf)
    data_f5-utils-file-transfer_file-post:
      title: data_f5-utils-file-transfer_file-post
      type: object
      properties:
        f5-utils-file-transfer:insecure:
          type: string
          description: Disable remote system identity verification (leaf)
        f5-utils-file-transfer:protocol:
          $ref: '#/components/schemas/F5UtilsFileTransferProtocol'
        f5-utils-file-transfer:username:
          type: string
          description: Provide the remote system username. (leaf)
        f5-utils-file-transfer:password:
          type: string
          description: Provide the remote system password in simple text. (leaf)
        f5-utils-file-transfer:web-token:
          type: string
          description: Provide the remote system web token. (leaf)
        f5-utils-file-transfer:remote-host:
          type: string
          description: Remote System FQDN or IPv4/IPv6 address. (leaf)
        f5-utils-file-transfer:remote-port:
          type: integer
          description: Provide port to connect to on the remote host. (leaf)
          format: int32
        f5-utils-file-transfer:remote-file:
          type: string
          description: Remote file path. (leaf)
        f5-utils-file-transfer:local-file:
          type: string
          description: Local file path. Accepts either absolute or relative path. (leaf)
        f5-utils-file-transfer:path:
          type: string
          description: Provide the directory/file path. (leaf)
        f5-utils-file-transfer:file-name:
          type: string
          description: Local file path. Accepts either absolute or relative path. (leaf)
    data_f5-utils-file-transfer_file:
      title: data_f5-utils-file-transfer_file
      type: object
      properties:
        f5-utils-file-transfer:file:
          type: object
          description: File utility commands. (non-presence)
    data_openconfig-system_system_f5-database_database_f5-database_reset-to-default-post-output:
      title: data_openconfig-system_system_f5-database_database_f5-database_reset-to-default-post-output
      type: object
      properties:
        f5-database:result:
          type: string
          description: Result of the reset-to-default response. (leaf)
    data_openconfig-system_system_f5-database_database_f5-database_reset-to-default-post-input:
      title: data_openconfig-system_system_f5-database_database_f5-database_reset-to-default-post-input
      type: object
      properties:
        f5-database:proceed:
          $ref: '#/components/schemas/F5DatabaseProceed'
    data_openconfig-system_system_f5-database_database_f5-database_config-restore-post-output:
      title: data_openconfig-system_system_f5-database_database_f5-database_config-restore-post-output
      type: object
      properties:
        f5-database:result:
          type: string
          description: Result of the config-restore response. (leaf)
    data_openconfig-system_system_f5-database_database_f5-database_config-restore-post-input:
      title: data_openconfig-system_system_f5-database_database_f5-database_config-restore-post-input
      type: object
      properties:
        f5-database:name:
          type: string
          description: (leaf)
    data_openconfig-system_system_f5-database_database_f5-database_config-backup-post-output:
      title: data_openconfig-system_system_f5-database_database_f5-database_config-backup-post-output
      type: object
      properties:
        f5-database:result:
          type: string
          description: Result of the config-backup response. (leaf)
    data_openconfig-system_system_f5-database_database_f5-database_config-backup-post-input:
      title: data_openconfig-system_system_f5-database_database_f5-database_config-backup-post-input
      type: object
      properties:
        f5-database:name:
          type: string
          description: (leaf)
    data_openconfig-system_system_f5-database_database_f5-database_cdb-backup-post-output:
      title: data_openconfig-system_system_f5-database_database_f5-database_cdb-backup-post-output
      type: object
      properties:
        f5-database:result:
          type: string
          description: Result of the cdb-backup operation. (leaf)
    data_openconfig-system_system_f5-database_database-post:
      title: data_openconfig-system_system_f5-database_database-post
      type: object
      properties:
        f5-database:name:
          type: string
          description: (leaf)
        f5-database:proceed:
          $ref: '#/components/schemas/F5DatabaseProceed'
    data_openconfig-system_system_f5-database_database:
      title: data_openconfig-system_system_f5-database_database
      type: object
      properties:
        f5-database:database:
          type: object
          description: (non-presence)
    F5DatabaseProceed:
      title: F5DatabaseProceed
      enum:
      - no
      - yes
      type: string
      description: (leaf)
    F5UtilsFileTransferEntry:
      title: F5UtilsFileTransferEntry
      type: object
      properties:
        name:
          type: string
          description: >-
            A Message indicating list of files/directories from

            result of file list action. (leaf)
    F5UtilsFileTransferProtocol:
      title: F5UtilsFileTransferProtocol
      enum:
      - scp
      - sftp
      - https
      type: string
      description: Choose protocol to be used for file transfer. (leaf)
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
security: []
tags:
- name: F5 Utils File Transfer
- name: F5 Openconfig System