apm oauth db-instance

apm oauth db-instance(1)				BIG-IP TMSH Manual				  apm oauth db-instance(1)

NAME
       db-instance - Manages various OAuth database instances for this partition.

MODULE
       apm oauth

SYNTAX
       Configure the db-instance component within the oauth module using the following syntax.

   CREATE/MODIFY
	create db-instance [name]
	modify db-instance [name]
	  options:
	    app-service [[string] | none]
	    description [[string] | none]
	    purge-frequency [daily | hourly | monthly | never | weekly]
	    purge-now
	    purge-time [string]
	edit db-instance [ [ [name] | [glob] | [regex] ] ... ]
	  options:
	    all-properties
	    non-default-properties
	    one-line

   DISPLAY
	list db-instance
	list db-instance [ [ [name] | [glob] | [regex] ] ... ]
	show running-config db-instance
	show running-config db-instance [ [ [name] | [glob] | [regex] ] ... ]
	  options:
	    all-properties
	    non-default-properties
	    one-line

   DELETE
	delete db-instance [name]

DESCRIPTION
       OAuth authorization server supports persistence for OAuth tokens and related data using on-disk databases. This data can be
       grouped into separate logical entities using database instances. The db-instance component can be used to manage such
       database instances within a partition.

       Because disk size is a limited resource, expired/obsolete tokens need to be purged in order to make space for newly issued
       tokens. The db-instance component provides options to purge either periodically, using combination of purge-frequency and
       purge-time or on-demand, using purge-now. The default setting for purge-frequency is daily and for purge-time is 02:00
       hours for a newly created database instance. When executed, database instance purging removes revoked, expired access
       tokens, refresh tokens, auth code and associated entries from the particular instance. Expired access tokens will not be
       removed if the reuse-access-token setting is enabled in the corresponding OAuth profile.

EXAMPLES
	       create db-instance myDbInstance {
		 description "Sales Team"
		 purge-frequency weekly
		 purge-time "00:00"
	       }

	   Creates a database instance named myDbInstance that, when associated with an OAuth profile, stores tokens related to
	   the OAuth profile in a separate database. This database instance is for the Sales team within the company. Stored data
	   is purged weekly at 12AM.

	       list db-instance

	   Displays a list of all DB instances on the Authorization server.

	       delete db-instance myDbInstance

	   Deletes the database instance myDbInstance.

OPTIONS
       app-service
	    Specifies the name of the application service to which the object belongs. The default value is none. Note: If the
	    strict-updates option is enabled on the application service that owns the object, you cannot modify or delete the
	    object. Only the application service can modify or delete the object.

       db-name
	    Specifies the actual name of the DB on BIG-IP. The value is unique for each DB instance and can be used to debug oauth
	    DB interactions with BIG-IP storage.

       description
	    Specifies a user-defined description for the database instance. The default value is none.

       [name]
	    Specifies the name of the OAuth database instance. This setting is required.

       partition
	    Displays the partition within which the component resides.

       purge-frequency
	    Specifies the frequency at which data should be purged. The default value is daily. Other possible values are hourly,
	    monthly, never and weekly.

       purge-now
	    Indicates a request to purge the data right now.

       purge-time
	    Specifies the time at which data should be purged. The default value is 02:00. HH:MM format must be used to specify
	    time value.

SEE ALSO
       apm profile oauth

COPYRIGHT
       No part of this program may be reproduced or transmitted in any form or by any means, electronic or mechanical, including
       photocopying, recording, or information storage and retrieval systems, for any purpose other than the purchaser's personal
       use, without the express written permission of F5 Networks, Inc.

       F5 Networks and BIG-IP (c) Copyright 2015-2016. All rights reserved.

BIG-IP							    2017-06-21					  apm oauth db-instance(1)