Splunk® Enterprise

Module System Reference

Acrobat logo Download manual as PDF


Splunk Enterprise version 7.3 will no longer be supported as of June 4, 2021. See the Splunk Software Support Policy for details. For information about upgrading to a supported version, see How to upgrade Splunk Enterprise.
This documentation does not apply to the most recent version of Splunk. Click here for the latest version.
Acrobat logo Download topic as PDF

SplunkAppObjModel

create()

The create() method creates a new version of the current object from the settings stored when the object was instantiated. This method wraps SplunkRESTModel.create(), and ensures that new instances of class SplunkAppObjModel have an owner of nobody and default to fail-safe metadata while retaining all other settings of the previous class SplunkAppObjModel instance.

Synopsis

status = create()

Return Value

Boolean Object create status:
True = Object successfully created.
False = Current object already has an ID, or unable to create a new entity. Object not created.

Example

from splunk.models.base import SplunkAppObjModel

class MyAppModel(SplunkAppObjModel): if MyAppModel.create():

   ... elided ...

else:

   ... elided ...

from_entity()

The from_entity() method populates the current model with the specified entity.

Synopsis

status = from_entity( entity )

Parameters

entity Object Entity from which to populate the current model.

Return Value

Boolean Populate model request status:
True = Model successfully populated.
False = Invalid entity  ; module not populated.

Example

from splunk.models.base import SplunkRESTModel

class MyAppModel(SplunkRESTModel): def populateModel (entity):

   try:
       my_entity = Eventtype.all().filter(name='failed-logins')
   except Exception, ex:
       raise
   my_instance = Eventtype('search', 'admin', 'failed-logins', entity=my_entity)
   if not my_instance.from_entity(my_instance.entity):
       ... elided ...
   else:
       ... elided ...

See Also

get()

share_app()

The share_app() method sets the sharing level to app, making the application visible to users who have permissions only within the current app context.

Synopsis

status = share_app()

Return Value

String Share request status:
True = Successful share request.
False = Share request failed due to invalid ID, entity or metadata.

Example

from splunk.models.saved_search import SavedSearch

class AlertsWizardController(BaseController):

       ... elided ...
       def step1_update(self, app, step, action, **params):
           saved_search = SavedSearch.get(params.get('id'))
           saved_search.update(params)
           if params.get('sharing')=='app':
               try:
                   saved_search.share_app()
               except Exception:
                   saved_search.errors = [_('Search %s cannot be shared.') \
                                         % saved_search.name ]

See Also

share_global()
unshare()

share_global()

The share_global() method sets the sharing level to global, making the application visible to users who have permissions across all apps.

Synopsis

status = share_global()

Return Value

String Share request status:
True = Successful share request.
False = Share request failed due to invalid ID, entity or metadata.

Example

from splunk.models.saved_search import SavedSearch

class AlertsWizardController(BaseController):

   ... elided ...
       def step1_update(self, **params):
           saved_search = SavedSearch.get(params.get('id'))
           saved_search.update(params)
           if params.get('sharing')=='global':
               try:
                   saved_search.share_global()
               except Exception:
                   saved_search.errors = [_('Search %s cannot be shared.') \
                                              % saved_search.name ]

See Also

share_app()
unshare()

unshare()

The unshare() method sets the sharing level to user, making the application visible to only the current user.

Synopsis

status = unshare()

Return Value

String Share request status:
True = Successful share request.
False = Share request failed due to invalid ID, entity or metadata.

Example

from splunk.models.saved_search import SavedSearch

class AlertsWizardController(BaseController):

       def step1_update(self, **params):
           saved_search = SavedSearch.get(params.get('id'))
           saved_search.update(params)
           if params.get('sharing')=='app':
               ... eliced ...
           else:
               try:
                   saved_search.unshare()
               except Exception:
                   saved_search.errors = [_('Search %s cannot be shared.') \
                                         % saved_search.name ]

See Also

share_app()
share_global()

Last modified on 12 August, 2019
PREVIOUS
SplunkRESTModel
  NEXT
ObjectMetadataModel

This documentation applies to the following versions of Splunk® Enterprise: 6.3.0, 6.3.1, 6.3.2, 6.3.3, 6.3.4, 6.3.5, 6.3.6, 6.3.7, 6.3.8, 6.3.9, 6.3.10, 6.3.11, 6.3.12, 6.3.13, 6.3.14, 6.4.0, 6.4.1, 6.4.2, 6.4.3, 6.4.4, 6.4.5, 6.4.6, 6.4.7, 6.4.8, 6.4.9, 6.4.10, 6.4.11, 6.5.0, 6.5.1, 6.5.2, 6.5.3, 6.5.4, 6.5.5, 6.5.6, 6.5.7, 6.5.8, 6.5.9, 6.5.10, 6.6.0, 6.6.1, 6.6.2, 6.6.3, 6.6.4, 6.6.5, 6.6.6, 6.6.7, 6.6.8, 6.6.9, 6.6.10, 6.6.11, 6.6.12, 7.0.0, 7.0.1, 7.0.2, 7.0.3, 7.0.4, 7.0.5, 7.0.6, 7.0.7, 7.0.8, 7.0.9, 7.0.10, 7.0.11, 7.0.13, 7.1.0, 7.1.1, 7.1.2, 7.1.3, 7.1.4, 7.1.5, 7.1.6, 7.1.7, 7.1.8, 7.1.9, 7.1.10, 7.2.0, 7.2.1, 7.2.2, 7.2.3, 7.2.4, 7.2.5, 7.2.6, 7.2.7, 7.2.8, 7.2.9, 7.2.10, 7.3.0, 7.3.1, 7.3.2, 7.3.3, 7.3.4, 7.3.5, 7.3.6, 7.3.7, 7.3.8, 7.3.9


Was this documentation topic helpful?

You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters