apm report custom-report-field

apm report custom-report-fieldBIG-IP TMSH Manapm report custom-report-field(1)



NAME
       custom-report-field - Configures a custom report field.

MODULE
       apm report

SYNTAX
       Configure the custom-report-field component within the custom-report
       module using the syntax shown in the following sections.

   CREATE/MODIFY
	create custom-report-field name [string] field-id [integer] field-position [integer] report-name [string]
	  options
	       alias [string]
	       app-service [string]
	       sort-direction [asc|desc|unsorted]
	       sort-order [integer]
	modify custom-report-field [alias | app-service | field-id | field-position | name | report-name | sort-direction | sort-order]
	  options
	       alias [string]
	       app-service [string]
	       field-position [integer]
	       report-name [string]
	       sort-direction [asc|desc|unsorted]
	       sort-order [integer]

   DISPLAY
	list custom-report-field
	list custom-report-field [alias | app-service | field-id | field-position | name | report-name | sort-direction | sort-order ]

DESCRIPTION
       Configures a custom report field with options.

       It is highly recommended that you use the web GUI to configure this
       custom object.

EXAMPLES
	     create alias UserName field-id 12 field-position 1 name
	    APDNOTICE_USERNAME.User_Name report-name cust1 sort-direction asc
	    sort-order 100000

	    Creates a custom-report-field named UserName under custom report
	    named cust1, field-position is 1, sort direction is ascending and
	    sort-order is 100000.

	    Note: Some field-id's and names are predefined and fixed values
	    and not customizable, see below for details:

	     apm report custom-report-field {
		field-id 21
		name APDNOTICE_CLIENT_INFO.Client_Version
	     }
	     apm report custom-report-field {
		field-id 19
		name APDNOTICE_CLIENT_INFO.Client_UI_Mode
	     }
	     apm report custom-report-field {
		field-id 16
		name APDNOTICE_ASSIGN_WEBTOP_LINKS.Webtop_Links
	     }
	     apm report custom-report-field {
		field-id 18
		name APDNOTICE_ACCESS_POLICY_RESULT.Access_Policy_Result
	     }
	     apm report custom-report-field {
		field-id 20
		name APDNOTICE_CLIENT_INFO.Client_Type
	     }
	     apm report custom-report-field {
		field-id 15
		name APDNOTICE_ASSIGN_WEBTOP.Webtop_Name
	     }
	     apm report custom-report-field {
		field-id 13
		name APDNOTICE_ASSIGN_ACL.ACL_variable
	     }
	     apm report custom-report-field {
		field-id 12
		name APDNOTICE_USERNAME.User_Name
	     }
	     apm report custom-report-field {
		field-id 14
		name APDNOTICE_ASSIGN_RESOURCE.resource_var
	     }
	     apm report custom-report-field {
		field-id 17
		name APDNOTICE_CLIENT_INFO.Client_Platform
	     }

OPTIONS
       alias
	    Specifies the alias of the custom report field.

       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.

       field-id
	    Specifies a unique id of the custom report field. This item is
	    fixed and not customizable.

       field-position
	    Specifies field's position among all available fields.

       name Specifies a unique name for the custom report field. This item is
	    fixed and not customizable.

       report-name
	    Specifies the custom report that the custom-report-field belongs
	    to.

       sort-direction
	    Specifies the sort direction of the custom-report-field. It can be
	    asc, desc, or unsorted. Default is asc.

       sort-order
	    Specifies the sort order of the custom-report-field. Default is
	    100000.

SEE ALSO
       custom-report

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 2011-2013, 2015-2016. All rights
       reserved.



BIG-IP				  2016-03-14 apm report custom-report-field(1)