mgmt shared settings api-status availability
mgmt shared settings api-statuBmgmtPsharedMsettings api-status availability(1)
NAME
availability - Configures the accessibility of the elements that have
one of the specified API lifecycle states.
MODULE
mgmt shared settings api-status
SYNTAX
Configure the availability component within the mgmt shared settings
api-status module using the syntax shown in the following sections.
MODIFY
modify availability
options:
deprecatedApiAllowed [true | false]
earlyAccessApiAllowed [true | false]
testOnlyApiAllowed [true | false]
DISPLAY
list availability
options:
deprecatedApiAllowed
earlyAccessApiAllowed
testOnlyApiAllowed
DESCRIPTION
There are six F5 API lifecycle states namely: internal, testOnly,
earlyAccess, generalAccess, deprecated, noStatus. These states are
described at the end of this page. For the commands, command properties
in deprecated, earlyAccess and testOnly states the availability can be
configured by the user.
The availability settings indicate if the commands or properties within
a command are accessible to the user. For example: if the
deprecatedApiAllowed property is set to false; then it implies that the
commands and properties with deprecated status are not available to
user. i.e. These elements will not be available for create, modify,
delete commands. For list action, the elements will not displayed at
the command line.
Warnings will be generated at stderr and /var/log/ltm based on the
mgmt::shared::settings::api-status::log::resource and resource-property
settings.
If these settings are modified in the tmsh interactive mode then, the
user has to exit the tmsh interactive mode and re-enter for the
settings to be effective.
OPTIONS
deprecatedApiAllowed
Determines the accessibility of commands, properties in deprecated
state. The default value is true.
earlyAccessApiAllowed
Determines the accessibility of commands, properties in
earlyAccess state. The default value is true.
testOnlyApiAllowed
Determines the accessibility of commands, properties in testOnly
state. The default value is false.
The remaining properties are read-only and are not user modifiable.
F5 API lifecycle policy
The F5 API lifecycle consists of five states, namely: internal,
testOnly, earlyAccess, generalAccess, deprecated, noStatus. These
states can be described as follows:
internal
Internal routing not exposed through public interface
testOnly
Enabled only when test variable configured. Used internally for
test cases that require special-case workers to complete
functional testing for features not exposed in public API.
earlyAccess
Experimental and susceptible to change in future releases. Used
for new features that haven't had time to be solidified.
generalAccess
API that satisfies the API general access release policy.
deprecated
Resource still exists in the API but indicates that there is an
preferred alternative or that it may be removed in the future
based on deprecation policy.
noStatus
For backward compatibility for APIs not categorized. At some point
this status will be disallowed and build time break will occur if
resource not categorized with appropriate flag.
In the write-up above the terms command, command::properties are used
in place of API to describe the behavior of the
mgmt::shared::settings::api-status::availability settings.
SEE ALSO
mgmt shared settings api-status log resource, mgmt shared setting api-
status log resource-property
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 2013-2016. All rights reserved.
BIG-IP mgmt0shared1settings api-status availability(1)